Function SDL_SetTextInputArea

pub unsafe extern "C" fn SDL_SetTextInputArea(
    window: *mut SDL_Window,
    rect: *const SDL_Rect,
    cursor: i32,
) -> bool

Available on crate feature dep_sdl3 only.

Set the area used to type Unicode text input.

Native input methods may place a window with word suggestions near the cursor, without covering the text being entered.

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

• SDL_GetTextInputArea
• SDL_StartTextInput