devela::_dep::sdl3::sys::mouse

Function SDL_SetCursor

pub unsafe extern "C" fn SDL_SetCursor(
    cursor: *mut SDL_Cursor,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Set the active cursor.

This function sets the currently active cursor to the specified one. If the cursor is currently visible, the change will be immediately represented on the display. SDL_SetCursor(NULL) can be used to force cursor redraw, if this is desired for any reason.

§Parameters

  • cursor: a cursor to make active.

§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