Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_GetRelativeMouseState (3)

Name

SDL_GetRelativeMouseState - Retrieve the current state of the mouse

Synopsis

#include "SDL.h"

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

Description

SDL API Reference                                 SDL_GetRelativeMouseState(3)



NAME
       SDL_GetRelativeMouseState - Retrieve the current state of the mouse

SYNOPSIS
       #include "SDL.h"

       Uint8 SDL_GetRelativeMouseState(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
       change  in  the  mouse position since the last call to SDL_GetRelative-
       MouseState or since event initialization. You can pass NULL for  either
       x or y.


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
SEE ALSO
       SDL_GetMouseState



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_GetRelativeMouseState(3)