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


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


Toggle whether or not the cursor is shown.


int SDL_ShowCursor(int toggle);

Function Parameters


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

Return Value

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.


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.


This function is available since SDL 3.0.0.

Code Examples

int main(int argc, char *argv[]) {
    /* creates a blank cursor */
    /* ... */
    return 0;

CategoryAPI, CategoryMouse, CategoryDraft

[ edit | delete | history | feedback | raw ]

[ 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.