devela::_dep::sdl3::sys::everything

Function SDL_GetTextInputArea

pub unsafe extern "C" fn SDL_GetTextInputArea(
    window: *mut SDL_Window,
    rect: *mut SDL_Rect,
    cursor: *mut i32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Get the area used to type Unicode text input.

This returns the values previously set by SDL_SetTextInputArea().

§Parameters

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

§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