(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

Draft

THIS PAGE IS A WORK IN PROGRESS ... Please make edits to this page to improve it!

SDL_SetCursor

Set the active cursor.

Header File

Defined in SDL_mouse.h, but apps should use #include <SDL3/SDL.h>

Syntax

int SDL_SetCursor(SDL_Cursor * cursor);

Function Parameters

cursor

a cursor to make active

Return Value

Returns 0 on success or a negative error code 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.

Version

This function is available since SDL 3.0.0.