Mercurial > sdl-ios-xcode
view docs/man3/SDL_GetMouseState.3 @ 3164:c5b2884c26b4
Added an ifdef so that if you
#define SDL_NO_COMPAT
before you include SDL.h then SDL_compat.h will never be included in your code.
This is useful for making sure that your code uses only SDL 1.3 features.
It is also handy for finding things that are in SDL_compat.h that belong elsewhere.
| author | Bob Pendleton <bob@pendleton.com> |
|---|---|
| date | Thu, 04 Jun 2009 21:00:45 +0000 |
| parents | 546f7c1eb755 |
| children | 1238da4a7112 |
line wrap: on
line source
.TH "SDL_GetMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" .SH "NAME" SDL_GetMouseState \- Retrieve the current state of the mouse .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBUint8 \fBSDL_GetMouseState\fP\fR(\fBint *x, int *y\fR); .SH "DESCRIPTION" .PP 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\&. .SH "EXAMPLE" .PP .nf \f(CWSDL_PumpEvents(); if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1)) printf("Mouse Button 1(left) is pressed\&. ");\fR .fi .PP .SH "SEE ALSO" .PP \fI\fBSDL_GetRelativeMouseState\fP\fR, \fI\fBSDL_PumpEvents\fP\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59