]> git.xonotic.org Git - xonotic/xonotic.git/blob - misc/builddeps/dp.win64/share/man/man3/SDL_GetMouseState.3
Merge branch 'master' of ssh://git.xonotic.org/xonotic
[xonotic/xonotic.git] / misc / builddeps / dp.win64 / share / man / man3 / SDL_GetMouseState.3
1 .TH "SDL_GetMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_GetMouseState \- Retrieve the current state of the mouse
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBUint8 \fBSDL_GetMouseState\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 current mouse cursor position\&. You can pass \fBNULL\fP for either \fBx\fR or \fBy\fR\&.
12 .SH "EXAMPLE"
13 .PP
14 .nf
15 \f(CWSDL_PumpEvents();
16 if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1))
17   printf("Mouse Button 1(left) is pressed\&.
18 ");\fR
19 .fi
20 .PP
21 .SH "SEE ALSO"
22 .PP
23 \fI\fBSDL_GetRelativeMouseState\fP\fR, \fI\fBSDL_PumpEvents\fP\fR
24 .\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59