(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_TextInputEvent

Keyboard text input event structure (event.text.*)

Header File

Defined in <SDL3/SDL_events.h>

Syntax

typedef struct SDL_TextInputEvent
{
    SDL_EventType type; /**< SDL_EVENT_TEXT_INPUT */
    Uint32 reserved;
    Uint64 timestamp;   /**< In nanoseconds, populated using SDL_GetTicksNS() */
    SDL_WindowID windowID; /**< The window with keyboard focus, if any */
    char *text;         /**< The input text, UTF-8 encoded */
} SDL_TextInputEvent;

Remarks

The text is owned by SDL and should be copied if the application wants to hold onto it beyond the scope of handling this event.

This event will never be delivered unless text input is enabled by calling SDL_StartTextInput(). Text input is disabled by default!

Version

This struct is available since SDL 3.0.0.

See Also

• SDL_StartTextInput
• SDL_StopTextInput

CategoryAPI, CategoryAPIStruct, CategoryEvents