Mercurial > sdl-ios-xcode
annotate docs/html/sdlgetrelativemousestate.html @ 181:e5bc29de3f0a
Updated from the SDL Documentation Project
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 14 Sep 2001 02:41:09 +0000 |
parents | 55f1f1b3e27d |
children | 355632dca928 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_GetRelativeMouseState</TITLE | |
5 ><META | |
6 NAME="GENERATOR" | |
55
55f1f1b3e27d
Added new docs for SDL 1.2.1
Sam Lantinga <slouken@lokigames.com>
parents:
0
diff
changeset
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64 |
0 | 8 "><LINK |
9 REL="HOME" | |
10 TITLE="SDL Library Documentation" | |
11 HREF="index.html"><LINK | |
12 REL="UP" | |
13 TITLE="Event Functions." | |
14 HREF="eventfunctions.html"><LINK | |
15 REL="PREVIOUS" | |
16 TITLE="SDL_GetMouseState" | |
17 HREF="sdlgetmousestate.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_GetAppState" | |
20 HREF="sdlgetappstate.html"></HEAD | |
21 ><BODY | |
22 CLASS="REFENTRY" | |
23 BGCOLOR="#FFF8DC" | |
24 TEXT="#000000" | |
25 LINK="#0000ee" | |
26 VLINK="#551a8b" | |
27 ALINK="#ff0000" | |
28 ><DIV | |
29 CLASS="NAVHEADER" | |
30 ><TABLE | |
31 WIDTH="100%" | |
32 BORDER="0" | |
33 CELLPADDING="0" | |
34 CELLSPACING="0" | |
35 ><TR | |
36 ><TH | |
37 COLSPAN="3" | |
38 ALIGN="center" | |
39 >SDL Library Documentation</TH | |
40 ></TR | |
41 ><TR | |
42 ><TD | |
43 WIDTH="10%" | |
44 ALIGN="left" | |
45 VALIGN="bottom" | |
46 ><A | |
47 HREF="sdlgetmousestate.html" | |
48 >Prev</A | |
49 ></TD | |
50 ><TD | |
51 WIDTH="80%" | |
52 ALIGN="center" | |
53 VALIGN="bottom" | |
54 ></TD | |
55 ><TD | |
56 WIDTH="10%" | |
57 ALIGN="right" | |
58 VALIGN="bottom" | |
59 ><A | |
60 HREF="sdlgetappstate.html" | |
61 >Next</A | |
62 ></TD | |
63 ></TR | |
64 ></TABLE | |
65 ><HR | |
66 ALIGN="LEFT" | |
67 WIDTH="100%"></DIV | |
68 ><H1 | |
69 ><A | |
70 NAME="SDLGETRELATIVEMOUSESTATE" | |
71 >SDL_GetRelativeMouseState</A | |
72 ></H1 | |
73 ><DIV | |
74 CLASS="REFNAMEDIV" | |
75 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
76 NAME="AEN5514" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_GetRelativeMouseState -- Retrieve the current state of the mouse</DIV | |
81 ><DIV | |
82 CLASS="REFSYNOPSISDIV" | |
83 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
84 NAME="AEN5517" |
0 | 85 ></A |
86 ><H2 | |
87 >Synopsis</H2 | |
88 ><DIV | |
89 CLASS="FUNCSYNOPSIS" | |
90 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
91 NAME="AEN5518" |
0 | 92 ></A |
93 ><P | |
94 ></P | |
95 ><PRE | |
96 CLASS="FUNCSYNOPSISINFO" | |
97 >#include "SDL.h"</PRE | |
98 ><P | |
99 ><CODE | |
100 ><CODE | |
101 CLASS="FUNCDEF" | |
102 >Uint8 <B | |
103 CLASS="FSFUNC" | |
104 >SDL_GetRelativeMouseState</B | |
105 ></CODE | |
106 >(int *x, int *y);</CODE | |
107 ></P | |
108 ><P | |
109 ></P | |
110 ></DIV | |
111 ></DIV | |
112 ><DIV | |
113 CLASS="REFSECT1" | |
114 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
115 NAME="AEN5524" |
0 | 116 ></A |
117 ><H2 | |
118 >Description</H2 | |
119 ><P | |
120 >The current button state is returned as a button bitmask, which can | |
121 be tested using the <TT | |
122 CLASS="LITERAL" | |
123 >SDL_BUTTON(X)</TT | |
124 > macros, and <TT | |
125 CLASS="PARAMETER" | |
126 ><I | |
127 >x</I | |
128 ></TT | |
129 > and <TT | |
130 CLASS="PARAMETER" | |
131 ><I | |
132 >y</I | |
133 ></TT | |
134 > are set to the change in the mouse position since the last call to <TT | |
135 CLASS="FUNCTION" | |
136 >SDL_GetRelativeMouseState</TT | |
137 > or since event initialization. You can pass <TT | |
138 CLASS="LITERAL" | |
139 >NULL</TT | |
140 > for either <TT | |
141 CLASS="PARAMETER" | |
142 ><I | |
143 >x</I | |
144 ></TT | |
145 > or <TT | |
146 CLASS="PARAMETER" | |
147 ><I | |
148 >y</I | |
149 ></TT | |
150 >.</P | |
151 ></DIV | |
152 ><DIV | |
153 CLASS="REFSECT1" | |
154 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
155 NAME="AEN5534" |
0 | 156 ></A |
157 ><H2 | |
158 >See Also</H2 | |
159 ><P | |
160 ><A | |
161 HREF="sdlgetmousestate.html" | |
162 ><TT | |
163 CLASS="FUNCTION" | |
164 >SDL_GetMouseState</TT | |
165 ></A | |
166 ></P | |
167 ></DIV | |
168 ><DIV | |
169 CLASS="NAVFOOTER" | |
170 ><HR | |
171 ALIGN="LEFT" | |
172 WIDTH="100%"><TABLE | |
173 WIDTH="100%" | |
174 BORDER="0" | |
175 CELLPADDING="0" | |
176 CELLSPACING="0" | |
177 ><TR | |
178 ><TD | |
179 WIDTH="33%" | |
180 ALIGN="left" | |
181 VALIGN="top" | |
182 ><A | |
183 HREF="sdlgetmousestate.html" | |
184 >Prev</A | |
185 ></TD | |
186 ><TD | |
187 WIDTH="34%" | |
188 ALIGN="center" | |
189 VALIGN="top" | |
190 ><A | |
191 HREF="index.html" | |
192 >Home</A | |
193 ></TD | |
194 ><TD | |
195 WIDTH="33%" | |
196 ALIGN="right" | |
197 VALIGN="top" | |
198 ><A | |
199 HREF="sdlgetappstate.html" | |
200 >Next</A | |
201 ></TD | |
202 ></TR | |
203 ><TR | |
204 ><TD | |
205 WIDTH="33%" | |
206 ALIGN="left" | |
207 VALIGN="top" | |
208 >SDL_GetMouseState</TD | |
209 ><TD | |
210 WIDTH="34%" | |
211 ALIGN="center" | |
212 VALIGN="top" | |
213 ><A | |
214 HREF="eventfunctions.html" | |
215 >Up</A | |
216 ></TD | |
217 ><TD | |
218 WIDTH="33%" | |
219 ALIGN="right" | |
220 VALIGN="top" | |
221 >SDL_GetAppState</TD | |
222 ></TR | |
223 ></TABLE | |
224 ></DIV | |
225 ></BODY | |
226 ></HTML | |
227 > |