SDL_SetTextInputArea - Man Page
Set the area used to type Unicode text input.
Synopsis
#include <SDL3/SDL_keyboard.h> bool SDL_SetTextInputArea(SDL_Window *window, const SDL_Rect *rect, int cursor);
Description
Native input methods may place a window with word suggestions near the cursor, without covering the text being entered.
Function Parameters
- window
the window for which to set the text input area.
- rect
the SDL_Rect representing the text input area, in window coordinates, or NULL to clear it.
- cursor
the offset of the current cursor location relative to rect->x, in window coordinates.
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
Referenced By
SDL_GetTextInputArea(3), SDL_StartTextInput(3), SDL_StartTextInputWithProperties(3).
SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS