(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_StartTextInput

Start accepting Unicode text input events in a window.

Header File

Syntax

bool SDL_StartTextInput(SDL_Window *window);

Function Parameters

SDL_Window *

window

the window to enable text input.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.3.