table of contents
SDL_StartTextInput(3) | SDL3 FUNCTIONS | SDL_StartTextInput(3) |
NAME¶
SDL_StartTextInput - Start accepting Unicode text input events in a window.
HEADER FILE¶
Defined in SDL3/SDL_keyboard.h
SYNOPSIS¶
#include "SDL3/SDL.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.
AVAILABILITY¶
This function is available since SDL 3.1.3.
SEE ALSO¶
•(3), SDL_SetTextInputArea(3), •(3), SDL_StartTextInputWithProperties(3), •(3), SDL_StopTextInput(3), •(3), SDL_TextInputActive(3)
SDL 3.1.6 | Simple Directmedia Layer |