SDL_SetTextInputArea(3)

SDL_SetTextInputArea3

Set the area used to type unicode text input.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_keyboard.h

Overview

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.

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