SDL_StartTextInput3
Start accepting unicode text input events in a window.
Usage
#include "SDL3/SDL.h"
bool SDL_StartTextInput(SDL_Window *window);
Header file
Defined in SDL3/SDL_keyboard.h
Overview
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.