(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetTextInputArea

Get the area used to type Unicode text input.

Header File

Defined in <SDL3/SDL_keyboard.h>

Syntax

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

Function Parameters

SDL_Window *	window	the window for which to query the text input area.
SDL_Rect *	rect	a pointer to an SDL_Rect filled in with the text input area, may be NULL.
int *	cursor	a pointer to the offset of the current cursor location relative to rect->x, may be NULL.

Return Value

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

Remarks

This returns the values previously set by SDL_SetTextInputArea().

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetTextInputArea

---

CategoryAPI, CategoryAPIFunction, CategoryKeyboard

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.