Mercurial > sdl-ios-xcode

view docs/man3/SDL_GetMouseState.3 @ 593:0136d21b7764

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Fri, 31 Jan 2003 15:17:30 +0100 From: Patrice Mandin Subject: [SDL] Small patches for SDL - One for SDL, which removes check for SDL_VIDEODRIVER in the Atari video drivers. It is unnecessary 'cause it is done in SDL_video.c
author Sam Lantinga <slouken@libsdl.org>
date Tue, 04 Feb 2003 21:01:03 +0000
parents e5bc29de3f0a
children 546f7c1eb755
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