diff docs/man3/SDL_GetMouseState.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_GetMouseState.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,24 @@
+.TH "SDL_GetMouseState" "3" "Mon 12 Mar 2001, 01:03" "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, Mon 12 Mar 2001, 01:03