logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_StartTextInput - Start accepting Unicode text input events in a window.

Availability

       This function is available since SDL 3.2.0.

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.

Name

       SDL_StartTextInput - Start accepting Unicode text input events in a window.

Return Value

       for more information.

See Also

SDL_SetTextInputArea(3),            SDL_StartTextInputWithProperties(3),            SDL_StopTextInput(3),
       SDL_TextInputActive(3)

Simple Directmedia Layer                           SDL 3.2.20                              SDL_StartTextInput(3)

Synopsis

#include<SDL3/SDL_keyboard.h>boolSDL_StartTextInput(SDL_Window*window);

Thread Safety

       This function should only be called on the main thread.

See Also