Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_ShowCursor (3)

Name

SDL_ShowCursor - Toggle whether or not the cursor is shown on the screen.

Synopsis

#include "SDL.h"

int SDL_ShowCursor(int toggle);

Description

SDL_ShowCursor(3)              SDL API Reference             SDL_ShowCursor(3)



NAME
       SDL_ShowCursor  -  Toggle  whether  or  not  the cursor is shown on the
       screen.

SYNOPSIS
       #include "SDL.h"

       int SDL_ShowCursor(int toggle);

DESCRIPTION
       Toggle whether or not the  cursor  is  shown  on  the  screen.  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.

       The cursor starts off displayed, but can be turned off.

RETURN VALUE
       Returns the current state of the cursor.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_CreateCursor, SDL_SetCursor



NOTES
       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source        was        downloaded        from        https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:01           SDL_ShowCursor(3)