SDL_StartTextInput - Man Page
Start accepting Unicode text input events in a window.
Synopsis
#include <SDL3/SDL_keyboard.h> bool SDL_StartTextInput(SDL_Window *window);
Description
This function will enable text input (SDL_EVENT_TEXT_INPUT and SDL_EVENT_TEXT_EDITING events) in the specified window. Please use this function paired with SDL_StopTextInput().
Text input events are not received by default.
On some platforms using this function shows the screen keyboard and/or activates an IME, which can prevent some key press events from being passed through.
Function Parameters
- window
the window to enable text input.
Return Value
Returns true on success or false on failure; call SDL_GetError() for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
SDL_SetTextInputArea(3), SDL_StartTextInputWithProperties(3), SDL_StopTextInput(3), SDL_TextInputActive(3)
Referenced By
SDL_ClearComposition(3), SDL_HasScreenKeyboardSupport(3), SDL_SetTextInputArea(3), SDL_StartTextInputWithProperties(3), SDL_StopTextInput(3), SDL_TextInputActive(3), SDL_TextInputEvent.3type(3).