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

SDL_GetCursor

Get the active cursor.

Header File

Defined in <SDL3/SDL_mouse.h>

Syntax

SDL_Cursor * SDL_GetCursor(void);

Return Value

(SDL_Cursor *) Returns the active cursor or NULL if there is no mouse.

Remarks

This function returns a pointer to the current cursor which is owned by the library. It is not necessary to free the cursor with SDL_DestroyCursor().

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetCursor

---

CategoryAPI, CategoryAPIFunction, CategoryMouse

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.