SDL_TextEditingEvent.3type - Man Page

Keyboard text editing event structure (event.edit.*)

Header File

Defined in SDL3/SDL_events.h

Synopsis

#include "SDL3/SDL.h"

typedef struct SDL_TextEditingEvent
{
    SDL_EventType type;         /**< SDL_EVENT_TEXT_EDITING */
    Uint32 reserved;
    Uint64 timestamp;           /**< In nanoseconds, populated using SDL_GetTicksNS() */
    SDL_WindowID windowID;      /**< The window with keyboard focus, if any */
    const char *text;           /**< The editing text */
    Sint32 start;               /**< The start cursor of selected editing text, or -1 if not set */
    Sint32 length;              /**< The length of selected editing text, or -1 if not set */
} SDL_TextEditingEvent;

Description

The start cursor is the position, in UTF-8 characters, where new typing will be inserted into the editing text. The length is the number of UTF-8 characters that will be replaced by new typing.

Availability

This struct is available since SDL 3.2.0.

Info

SDL 3.2.2 Simple Directmedia Layer SDL3 DATATYPES