(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_ShowCursor

Toggle whether or not the cursor is shown.

Header File

Syntax

int SDL_ShowCursor(int toggle);

Function Parameters

int toggle SDL_ENABLE to show the cursor, SDL_DISABLE to hide it, SDL_QUERY to query the current state without changing it.

Return Value

(int) Returns SDL_ENABLE if the cursor is shown, or SDL_DISABLE if the cursor is hidden, or a negative error code on failure; call SDL_GetError() for more information.

Remarks

The cursor starts off displayed but can be turned off. Passing SDL_ENABLE displays the cursor and passing SDL_DISABLE hides it.

The current state of the mouse cursor can be queried by passing SDL_QUERY; either SDL_DISABLE or SDL_ENABLE will be returned.

Version

This function is available since SDL 2.0.0.