SDL_GetTextInputArea(3)

SDL_GetTextInputArea3

Get the area used to type unicode text input.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_keyboard.h

Overview

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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.