(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetCursor

Set the active cursor.

Header File

Syntax

bool SDL_SetCursor(SDL_Cursor *cursor);

Function Parameters

SDL_Cursor *

cursor

a cursor to make active.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.