349f47d81992d8febbc6e7045d7dd2a52cb72396
[sdl_omap.git] / docs / man3 / SDL_GetRelativeMouseState.3
1 .TH "SDL_GetRelativeMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_GetRelativeMouseState \- Retrieve the current state of the mouse
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBUint8 \fBSDL_GetRelativeMouseState\fP\fR(\fBint *x, int *y\fR);
9 .SH "DESCRIPTION"
10 .PP
11 The current button state is returned as a button bitmask, which can be tested using the \fBSDL_BUTTON(X)\fP macros, and \fBx\fR and \fBy\fR are set to the change in the mouse position since the last call to \fBSDL_GetRelativeMouseState\fP or since event initialization\&. You can pass \fBNULL\fP for either \fBx\fR or \fBy\fR\&.
12 .SH "SEE ALSO"
13 .PP
14 \fI\fBSDL_GetMouseState\fP\fR
15 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59