SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Set the rectangle used to type Unicode text inputs.

Header File

Defined in <SDL3/SDL_keyboard.h>


int SDL_SetTextInputRect(const SDL_Rect *rect);

Function Parameters

const SDL_Rect * rect the SDL_Rect structure representing the rectangle to receive text (ignored if NULL).

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


Native input methods will place a window with word suggestions near it, without covering the text being inputted.

To start text input in a given location, this function is intended to be called before SDL_StartTextInput, although some platforms support moving the rectangle even while text input (and a composition) is active.

Note: If you want to use the system native IME window, try setting hint SDL_HINT_IME_SHOW_UI to 1, otherwise this function won't give you any feedback.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryKeyboard

[ edit | delete | history | feedback | raw ]

[ 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.