docs/html/sdlgetrelativemousestate.html
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/html/sdlgetrelativemousestate.html	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,235 +0,0 @@
     1.4 -<HTML
     1.5 -><HEAD
     1.6 -><TITLE
     1.7 ->SDL_GetRelativeMouseState</TITLE
     1.8 -><META
     1.9 -NAME="GENERATOR"
    1.10 -CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
    1.11 -"><LINK
    1.12 -REL="HOME"
    1.13 -TITLE="SDL Library Documentation"
    1.14 -HREF="index.html"><LINK
    1.15 -REL="UP"
    1.16 -TITLE="Event Functions."
    1.17 -HREF="eventfunctions.html"><LINK
    1.18 -REL="PREVIOUS"
    1.19 -TITLE="SDL_GetMouseState"
    1.20 -HREF="sdlgetmousestate.html"><LINK
    1.21 -REL="NEXT"
    1.22 -TITLE="SDL_GetAppState"
    1.23 -HREF="sdlgetappstate.html"></HEAD
    1.24 -><BODY
    1.25 -CLASS="REFENTRY"
    1.26 -BGCOLOR="#FFF8DC"
    1.27 -TEXT="#000000"
    1.28 -LINK="#0000ee"
    1.29 -VLINK="#551a8b"
    1.30 -ALINK="#ff0000"
    1.31 -><DIV
    1.32 -CLASS="NAVHEADER"
    1.33 -><TABLE
    1.34 -SUMMARY="Header navigation table"
    1.35 -WIDTH="100%"
    1.36 -BORDER="0"
    1.37 -CELLPADDING="0"
    1.38 -CELLSPACING="0"
    1.39 -><TR
    1.40 -><TH
    1.41 -COLSPAN="3"
    1.42 -ALIGN="center"
    1.43 ->SDL Library Documentation</TH
    1.44 -></TR
    1.45 -><TR
    1.46 -><TD
    1.47 -WIDTH="10%"
    1.48 -ALIGN="left"
    1.49 -VALIGN="bottom"
    1.50 -><A
    1.51 -HREF="sdlgetmousestate.html"
    1.52 -ACCESSKEY="P"
    1.53 ->Prev</A
    1.54 -></TD
    1.55 -><TD
    1.56 -WIDTH="80%"
    1.57 -ALIGN="center"
    1.58 -VALIGN="bottom"
    1.59 -></TD
    1.60 -><TD
    1.61 -WIDTH="10%"
    1.62 -ALIGN="right"
    1.63 -VALIGN="bottom"
    1.64 -><A
    1.65 -HREF="sdlgetappstate.html"
    1.66 -ACCESSKEY="N"
    1.67 ->Next</A
    1.68 -></TD
    1.69 -></TR
    1.70 -></TABLE
    1.71 -><HR
    1.72 -ALIGN="LEFT"
    1.73 -WIDTH="100%"></DIV
    1.74 -><H1
    1.75 -><A
    1.76 -NAME="SDLGETRELATIVEMOUSESTATE"
    1.77 -></A
    1.78 ->SDL_GetRelativeMouseState</H1
    1.79 -><DIV
    1.80 -CLASS="REFNAMEDIV"
    1.81 -><A
    1.82 -NAME="AEN5902"
    1.83 -></A
    1.84 -><H2
    1.85 ->Name</H2
    1.86 ->SDL_GetRelativeMouseState&nbsp;--&nbsp;Retrieve the current state of the mouse</DIV
    1.87 -><DIV
    1.88 -CLASS="REFSYNOPSISDIV"
    1.89 -><A
    1.90 -NAME="AEN5905"
    1.91 -></A
    1.92 -><H2
    1.93 ->Synopsis</H2
    1.94 -><DIV
    1.95 -CLASS="FUNCSYNOPSIS"
    1.96 -><A
    1.97 -NAME="AEN5906"
    1.98 -></A
    1.99 -><P
   1.100 -></P
   1.101 -><PRE
   1.102 -CLASS="FUNCSYNOPSISINFO"
   1.103 ->#include "SDL.h"</PRE
   1.104 -><P
   1.105 -><CODE
   1.106 -><CODE
   1.107 -CLASS="FUNCDEF"
   1.108 ->Uint8 <B
   1.109 -CLASS="FSFUNC"
   1.110 ->SDL_GetRelativeMouseState</B
   1.111 -></CODE
   1.112 ->(int *x, int *y);</CODE
   1.113 -></P
   1.114 -><P
   1.115 -></P
   1.116 -></DIV
   1.117 -></DIV
   1.118 -><DIV
   1.119 -CLASS="REFSECT1"
   1.120 -><A
   1.121 -NAME="AEN5912"
   1.122 -></A
   1.123 -><H2
   1.124 ->Description</H2
   1.125 -><P
   1.126 ->The current button state is returned as a button bitmask, which can
   1.127 -be tested using the <TT
   1.128 -CLASS="LITERAL"
   1.129 ->SDL_BUTTON(X)</TT
   1.130 -> macros, and <TT
   1.131 -CLASS="PARAMETER"
   1.132 -><I
   1.133 ->x</I
   1.134 -></TT
   1.135 -> and <TT
   1.136 -CLASS="PARAMETER"
   1.137 -><I
   1.138 ->y</I
   1.139 -></TT
   1.140 -> are set to the change in the mouse position since the last call to <TT
   1.141 -CLASS="FUNCTION"
   1.142 ->SDL_GetRelativeMouseState</TT
   1.143 -> or since event initialization.  You can pass <TT
   1.144 -CLASS="LITERAL"
   1.145 ->NULL</TT
   1.146 -> for either <TT
   1.147 -CLASS="PARAMETER"
   1.148 -><I
   1.149 ->x</I
   1.150 -></TT
   1.151 -> or <TT
   1.152 -CLASS="PARAMETER"
   1.153 -><I
   1.154 ->y</I
   1.155 -></TT
   1.156 ->.</P
   1.157 -></DIV
   1.158 -><DIV
   1.159 -CLASS="REFSECT1"
   1.160 -><A
   1.161 -NAME="AEN5922"
   1.162 -></A
   1.163 -><H2
   1.164 ->See Also</H2
   1.165 -><P
   1.166 -><A
   1.167 -HREF="sdlgetmousestate.html"
   1.168 -><TT
   1.169 -CLASS="FUNCTION"
   1.170 ->SDL_GetMouseState</TT
   1.171 -></A
   1.172 -></P
   1.173 -></DIV
   1.174 -><DIV
   1.175 -CLASS="NAVFOOTER"
   1.176 -><HR
   1.177 -ALIGN="LEFT"
   1.178 -WIDTH="100%"><TABLE
   1.179 -SUMMARY="Footer navigation table"
   1.180 -WIDTH="100%"
   1.181 -BORDER="0"
   1.182 -CELLPADDING="0"
   1.183 -CELLSPACING="0"
   1.184 -><TR
   1.185 -><TD
   1.186 -WIDTH="33%"
   1.187 -ALIGN="left"
   1.188 -VALIGN="top"
   1.189 -><A
   1.190 -HREF="sdlgetmousestate.html"
   1.191 -ACCESSKEY="P"
   1.192 ->Prev</A
   1.193 -></TD
   1.194 -><TD
   1.195 -WIDTH="34%"
   1.196 -ALIGN="center"
   1.197 -VALIGN="top"
   1.198 -><A
   1.199 -HREF="index.html"
   1.200 -ACCESSKEY="H"
   1.201 ->Home</A
   1.202 -></TD
   1.203 -><TD
   1.204 -WIDTH="33%"
   1.205 -ALIGN="right"
   1.206 -VALIGN="top"
   1.207 -><A
   1.208 -HREF="sdlgetappstate.html"
   1.209 -ACCESSKEY="N"
   1.210 ->Next</A
   1.211 -></TD
   1.212 -></TR
   1.213 -><TR
   1.214 -><TD
   1.215 -WIDTH="33%"
   1.216 -ALIGN="left"
   1.217 -VALIGN="top"
   1.218 ->SDL_GetMouseState</TD
   1.219 -><TD
   1.220 -WIDTH="34%"
   1.221 -ALIGN="center"
   1.222 -VALIGN="top"
   1.223 -><A
   1.224 -HREF="eventfunctions.html"
   1.225 -ACCESSKEY="U"
   1.226 ->Up</A
   1.227 -></TD
   1.228 -><TD
   1.229 -WIDTH="33%"
   1.230 -ALIGN="right"
   1.231 -VALIGN="top"
   1.232 ->SDL_GetAppState</TD
   1.233 -></TR
   1.234 -></TABLE
   1.235 -></DIV
   1.236 -></BODY
   1.237 -></HTML
   1.238 ->
   1.239 \ No newline at end of file