Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_GetMouseState (3)

Name

SDL_GetMouseState - Retrieve the current state of the mouse

Synopsis

#include "SDL.h"

Uint8 SDL_GetMouseState(int *x, int *y);

Description

SDL_GetMouseState(3)           SDL API Reference          SDL_GetMouseState(3)



NAME
       SDL_GetMouseState - Retrieve the current state of the mouse

SYNOPSIS
       #include "SDL.h"

       Uint8 SDL_GetMouseState(int *x, int *y);

DESCRIPTION
       The  current button state is returned as a button bitmask, which can be
       tested using the SDL_BUTTON(X) macros, and x and y are set to the  cur-
       rent mouse cursor position. You can pass NULL for either x or y.

EXAMPLE
       SDL_PumpEvents();
       if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1))
         printf("Mouse Button 1(left) is pressed.
       ");

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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GetRelativeMouseState, SDL_PumpEvents



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, 22:59        SDL_GetMouseState(3)