SDL_SetCursor - Man Page

Set the active cursor.

Header File

Defined in SDL3/SDL_mouse.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_SetCursor(SDL_Cursor *cursor);

Description

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.

Function 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

·(3), SDL_GetCursor(3)

Referenced By

SDL_CreateColorCursor(3), SDL_CreateCursor(3), SDL_GetCursor(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS