diff docs/html/sdlgetmousestate.html @ 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/html/sdlgetmousestate.html	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,245 @@
+<HTML
+><HEAD
+><TITLE
+>SDL_GetMouseState</TITLE
+><META
+NAME="GENERATOR"
+CONTENT="Modular DocBook HTML Stylesheet Version 1.61
+"><LINK
+REL="HOME"
+TITLE="SDL Library Documentation"
+HREF="index.html"><LINK
+REL="UP"
+TITLE="Event Functions."
+HREF="eventfunctions.html"><LINK
+REL="PREVIOUS"
+TITLE="SDL_EnableKeyRepeat"
+HREF="sdlenablekeyrepeat.html"><LINK
+REL="NEXT"
+TITLE="SDL_GetRelativeMouseState"
+HREF="sdlgetrelativemousestate.html"></HEAD
+><BODY
+CLASS="REFENTRY"
+BGCOLOR="#FFF8DC"
+TEXT="#000000"
+LINK="#0000ee"
+VLINK="#551a8b"
+ALINK="#ff0000"
+><DIV
+CLASS="NAVHEADER"
+><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TH
+COLSPAN="3"
+ALIGN="center"
+>SDL Library Documentation</TH
+></TR
+><TR
+><TD
+WIDTH="10%"
+ALIGN="left"
+VALIGN="bottom"
+><A
+HREF="sdlenablekeyrepeat.html"
+>Prev</A
+></TD
+><TD
+WIDTH="80%"
+ALIGN="center"
+VALIGN="bottom"
+></TD
+><TD
+WIDTH="10%"
+ALIGN="right"
+VALIGN="bottom"
+><A
+HREF="sdlgetrelativemousestate.html"
+>Next</A
+></TD
+></TR
+></TABLE
+><HR
+ALIGN="LEFT"
+WIDTH="100%"></DIV
+><H1
+><A
+NAME="SDLGETMOUSESTATE"
+>SDL_GetMouseState</A
+></H1
+><DIV
+CLASS="REFNAMEDIV"
+><A
+NAME="AEN5247"
+></A
+><H2
+>Name</H2
+>SDL_GetMouseState&nbsp;--&nbsp;Retrieve the current state of the mouse</DIV
+><DIV
+CLASS="REFSYNOPSISDIV"
+><A
+NAME="AEN5250"
+></A
+><H2
+>Synopsis</H2
+><DIV
+CLASS="FUNCSYNOPSIS"
+><A
+NAME="AEN5251"
+></A
+><P
+></P
+><PRE
+CLASS="FUNCSYNOPSISINFO"
+>#include "SDL.h"</PRE
+><P
+><CODE
+><CODE
+CLASS="FUNCDEF"
+>Uint8 <B
+CLASS="FSFUNC"
+>SDL_GetMouseState</B
+></CODE
+>(int *x, int *y);</CODE
+></P
+><P
+></P
+></DIV
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN5257"
+></A
+><H2
+>Description</H2
+><P
+>The current button state is returned as a button bitmask, which can
+be tested using the <TT
+CLASS="LITERAL"
+>SDL_BUTTON(X)</TT
+> macros, and <TT
+CLASS="PARAMETER"
+><I
+>x</I
+></TT
+> and <TT
+CLASS="PARAMETER"
+><I
+>y</I
+></TT
+> are set to the
+current mouse cursor position.  You can pass <TT
+CLASS="LITERAL"
+>NULL</TT
+> for either <TT
+CLASS="PARAMETER"
+><I
+>x</I
+></TT
+> or <TT
+CLASS="PARAMETER"
+><I
+>y</I
+></TT
+>.</P
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN5266"
+></A
+><H2
+>Example</H2
+><PRE
+CLASS="PROGRAMLISTING"
+>SDL_PumpEvents();
+if(SDL_GetMouseState(NULL, NULL)&#38;SDL_BUTTON(1))
+  printf("Mouse Button 1(left) is pressed.\n");</PRE
+></DIV
+><DIV
+CLASS="REFSECT1"
+><A
+NAME="AEN5269"
+></A
+><H2
+>See Also</H2
+><P
+><A
+HREF="sdlgetrelativemousestate.html"
+><TT
+CLASS="FUNCTION"
+>SDL_GetRelativeMouseState</TT
+></A
+>,
+<A
+HREF="sdlpumpevents.html"
+><TT
+CLASS="FUNCTION"
+>SDL_PumpEvents</TT
+></A
+></P
+></DIV
+><DIV
+CLASS="NAVFOOTER"
+><HR
+ALIGN="LEFT"
+WIDTH="100%"><TABLE
+WIDTH="100%"
+BORDER="0"
+CELLPADDING="0"
+CELLSPACING="0"
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+><A
+HREF="sdlenablekeyrepeat.html"
+>Prev</A
+></TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="index.html"
+>Home</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+><A
+HREF="sdlgetrelativemousestate.html"
+>Next</A
+></TD
+></TR
+><TR
+><TD
+WIDTH="33%"
+ALIGN="left"
+VALIGN="top"
+>SDL_EnableKeyRepeat</TD
+><TD
+WIDTH="34%"
+ALIGN="center"
+VALIGN="top"
+><A
+HREF="eventfunctions.html"
+>Up</A
+></TD
+><TD
+WIDTH="33%"
+ALIGN="right"
+VALIGN="top"
+>SDL_GetRelativeMouseState</TD
+></TR
+></TABLE
+></DIV
+></BODY
+></HTML
+>
\ No newline at end of file