SDL_GetTextInputArea - Man Page

Get the area used to type Unicode text input.

Synopsis

#include <SDL3/SDL_keyboard.h>

bool SDL_GetTextInputArea(SDL_Window *window, SDL_Rect *rect, int *cursor);

Description

This returns the values previously set by SDL_SetTextInputArea().

Function Parameters

window

the window for which to query the text input area.

rect

a pointer to an SDL_Rect filled in with the text input area, may be NULL.

cursor

a pointer to the offset of the current cursor location relative to rect->x, may be NULL.

Return Value

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

Thread Safety

This function should only be called on the main thread.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_SetTextInputArea(3)

Referenced By

SDL_SetTextInputArea(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS