e14743d1 |
1 | <HTML |
2 | ><HEAD |
3 | ><TITLE |
4 | >SDL_GetRelativeMouseState</TITLE |
5 | ><META |
6 | NAME="GENERATOR" |
7 | CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+ |
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 | SUMMARY="Header navigation table" |
32 | WIDTH="100%" |
33 | BORDER="0" |
34 | CELLPADDING="0" |
35 | CELLSPACING="0" |
36 | ><TR |
37 | ><TH |
38 | COLSPAN="3" |
39 | ALIGN="center" |
40 | >SDL Library Documentation</TH |
41 | ></TR |
42 | ><TR |
43 | ><TD |
44 | WIDTH="10%" |
45 | ALIGN="left" |
46 | VALIGN="bottom" |
47 | ><A |
48 | HREF="sdlgetmousestate.html" |
49 | ACCESSKEY="P" |
50 | >Prev</A |
51 | ></TD |
52 | ><TD |
53 | WIDTH="80%" |
54 | ALIGN="center" |
55 | VALIGN="bottom" |
56 | ></TD |
57 | ><TD |
58 | WIDTH="10%" |
59 | ALIGN="right" |
60 | VALIGN="bottom" |
61 | ><A |
62 | HREF="sdlgetappstate.html" |
63 | ACCESSKEY="N" |
64 | >Next</A |
65 | ></TD |
66 | ></TR |
67 | ></TABLE |
68 | ><HR |
69 | ALIGN="LEFT" |
70 | WIDTH="100%"></DIV |
71 | ><H1 |
72 | ><A |
73 | NAME="SDLGETRELATIVEMOUSESTATE" |
74 | ></A |
75 | >SDL_GetRelativeMouseState</H1 |
76 | ><DIV |
77 | CLASS="REFNAMEDIV" |
78 | ><A |
79 | NAME="AEN5902" |
80 | ></A |
81 | ><H2 |
82 | >Name</H2 |
83 | >SDL_GetRelativeMouseState -- Retrieve the current state of the mouse</DIV |
84 | ><DIV |
85 | CLASS="REFSYNOPSISDIV" |
86 | ><A |
87 | NAME="AEN5905" |
88 | ></A |
89 | ><H2 |
90 | >Synopsis</H2 |
91 | ><DIV |
92 | CLASS="FUNCSYNOPSIS" |
93 | ><A |
94 | NAME="AEN5906" |
95 | ></A |
96 | ><P |
97 | ></P |
98 | ><PRE |
99 | CLASS="FUNCSYNOPSISINFO" |
100 | >#include "SDL.h"</PRE |
101 | ><P |
102 | ><CODE |
103 | ><CODE |
104 | CLASS="FUNCDEF" |
105 | >Uint8 <B |
106 | CLASS="FSFUNC" |
107 | >SDL_GetRelativeMouseState</B |
108 | ></CODE |
109 | >(int *x, int *y);</CODE |
110 | ></P |
111 | ><P |
112 | ></P |
113 | ></DIV |
114 | ></DIV |
115 | ><DIV |
116 | CLASS="REFSECT1" |
117 | ><A |
118 | NAME="AEN5912" |
119 | ></A |
120 | ><H2 |
121 | >Description</H2 |
122 | ><P |
123 | >The current button state is returned as a button bitmask, which can |
124 | be tested using the <TT |
125 | CLASS="LITERAL" |
126 | >SDL_BUTTON(X)</TT |
127 | > macros, and <TT |
128 | CLASS="PARAMETER" |
129 | ><I |
130 | >x</I |
131 | ></TT |
132 | > and <TT |
133 | CLASS="PARAMETER" |
134 | ><I |
135 | >y</I |
136 | ></TT |
137 | > are set to the change in the mouse position since the last call to <TT |
138 | CLASS="FUNCTION" |
139 | >SDL_GetRelativeMouseState</TT |
140 | > or since event initialization. You can pass <TT |
141 | CLASS="LITERAL" |
142 | >NULL</TT |
143 | > for either <TT |
144 | CLASS="PARAMETER" |
145 | ><I |
146 | >x</I |
147 | ></TT |
148 | > or <TT |
149 | CLASS="PARAMETER" |
150 | ><I |
151 | >y</I |
152 | ></TT |
153 | >.</P |
154 | ></DIV |
155 | ><DIV |
156 | CLASS="REFSECT1" |
157 | ><A |
158 | NAME="AEN5922" |
159 | ></A |
160 | ><H2 |
161 | >See Also</H2 |
162 | ><P |
163 | ><A |
164 | HREF="sdlgetmousestate.html" |
165 | ><TT |
166 | CLASS="FUNCTION" |
167 | >SDL_GetMouseState</TT |
168 | ></A |
169 | ></P |
170 | ></DIV |
171 | ><DIV |
172 | CLASS="NAVFOOTER" |
173 | ><HR |
174 | ALIGN="LEFT" |
175 | WIDTH="100%"><TABLE |
176 | SUMMARY="Footer navigation table" |
177 | WIDTH="100%" |
178 | BORDER="0" |
179 | CELLPADDING="0" |
180 | CELLSPACING="0" |
181 | ><TR |
182 | ><TD |
183 | WIDTH="33%" |
184 | ALIGN="left" |
185 | VALIGN="top" |
186 | ><A |
187 | HREF="sdlgetmousestate.html" |
188 | ACCESSKEY="P" |
189 | >Prev</A |
190 | ></TD |
191 | ><TD |
192 | WIDTH="34%" |
193 | ALIGN="center" |
194 | VALIGN="top" |
195 | ><A |
196 | HREF="index.html" |
197 | ACCESSKEY="H" |
198 | >Home</A |
199 | ></TD |
200 | ><TD |
201 | WIDTH="33%" |
202 | ALIGN="right" |
203 | VALIGN="top" |
204 | ><A |
205 | HREF="sdlgetappstate.html" |
206 | ACCESSKEY="N" |
207 | >Next</A |
208 | ></TD |
209 | ></TR |
210 | ><TR |
211 | ><TD |
212 | WIDTH="33%" |
213 | ALIGN="left" |
214 | VALIGN="top" |
215 | >SDL_GetMouseState</TD |
216 | ><TD |
217 | WIDTH="34%" |
218 | ALIGN="center" |
219 | VALIGN="top" |
220 | ><A |
221 | HREF="eventfunctions.html" |
222 | ACCESSKEY="U" |
223 | >Up</A |
224 | ></TD |
225 | ><TD |
226 | WIDTH="33%" |
227 | ALIGN="right" |
228 | VALIGN="top" |
229 | >SDL_GetAppState</TD |
230 | ></TR |
231 | ></TABLE |
232 | ></DIV |
233 | ></BODY |
234 | ></HTML |
235 | > |