Mercurial > sdl-ios-xcode
annotate docs/html/sdlgetmousestate.html @ 225:2d1753bc178a
Fixed building hermes objects with automake 1.5 (thanks winterlion)
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Fri, 02 Nov 2001 19:59:41 +0000 |
parents | e5bc29de3f0a |
children | 355632dca928 |
rev | line source |
---|---|
0 | 1 <HTML |
2 ><HEAD | |
3 ><TITLE | |
4 >SDL_GetMouseState</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_EnableKeyRepeat" | |
17 HREF="sdlenablekeyrepeat.html"><LINK | |
18 REL="NEXT" | |
19 TITLE="SDL_GetRelativeMouseState" | |
20 HREF="sdlgetrelativemousestate.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="sdlenablekeyrepeat.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="sdlgetrelativemousestate.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="SDLGETMOUSESTATE" | |
71 >SDL_GetMouseState</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="AEN5481" |
0 | 77 ></A |
78 ><H2 | |
79 >Name</H2 | |
80 >SDL_GetMouseState -- 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="AEN5484" |
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="AEN5485" |
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_GetMouseState</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="AEN5491" |
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 | |
135 current mouse cursor position. You can pass <TT | |
136 CLASS="LITERAL" | |
137 >NULL</TT | |
138 > for either <TT | |
139 CLASS="PARAMETER" | |
140 ><I | |
141 >x</I | |
142 ></TT | |
143 > or <TT | |
144 CLASS="PARAMETER" | |
145 ><I | |
146 >y</I | |
147 ></TT | |
148 >.</P | |
149 ></DIV | |
150 ><DIV | |
151 CLASS="REFSECT1" | |
152 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
153 NAME="AEN5500" |
0 | 154 ></A |
155 ><H2 | |
156 >Example</H2 | |
157 ><PRE | |
158 CLASS="PROGRAMLISTING" | |
159 >SDL_PumpEvents(); | |
160 if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1)) | |
161 printf("Mouse Button 1(left) is pressed.\n");</PRE | |
162 ></DIV | |
163 ><DIV | |
164 CLASS="REFSECT1" | |
165 ><A | |
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
166 NAME="AEN5503" |
0 | 167 ></A |
168 ><H2 | |
169 >See Also</H2 | |
170 ><P | |
171 ><A | |
172 HREF="sdlgetrelativemousestate.html" | |
173 ><TT | |
174 CLASS="FUNCTION" | |
175 >SDL_GetRelativeMouseState</TT | |
176 ></A | |
177 >, | |
178 <A | |
179 HREF="sdlpumpevents.html" | |
180 ><TT | |
181 CLASS="FUNCTION" | |
182 >SDL_PumpEvents</TT | |
183 ></A | |
184 ></P | |
185 ></DIV | |
186 ><DIV | |
187 CLASS="NAVFOOTER" | |
188 ><HR | |
189 ALIGN="LEFT" | |
190 WIDTH="100%"><TABLE | |
191 WIDTH="100%" | |
192 BORDER="0" | |
193 CELLPADDING="0" | |
194 CELLSPACING="0" | |
195 ><TR | |
196 ><TD | |
197 WIDTH="33%" | |
198 ALIGN="left" | |
199 VALIGN="top" | |
200 ><A | |
201 HREF="sdlenablekeyrepeat.html" | |
202 >Prev</A | |
203 ></TD | |
204 ><TD | |
205 WIDTH="34%" | |
206 ALIGN="center" | |
207 VALIGN="top" | |
208 ><A | |
209 HREF="index.html" | |
210 >Home</A | |
211 ></TD | |
212 ><TD | |
213 WIDTH="33%" | |
214 ALIGN="right" | |
215 VALIGN="top" | |
216 ><A | |
217 HREF="sdlgetrelativemousestate.html" | |
218 >Next</A | |
219 ></TD | |
220 ></TR | |
221 ><TR | |
222 ><TD | |
223 WIDTH="33%" | |
224 ALIGN="left" | |
225 VALIGN="top" | |
226 >SDL_EnableKeyRepeat</TD | |
227 ><TD | |
228 WIDTH="34%" | |
229 ALIGN="center" | |
230 VALIGN="top" | |
231 ><A | |
232 HREF="eventfunctions.html" | |
233 >Up</A | |
234 ></TD | |
235 ><TD | |
236 WIDTH="33%" | |
237 ALIGN="right" | |
238 VALIGN="top" | |
239 >SDL_GetRelativeMouseState</TD | |
240 ></TR | |
241 ></TABLE | |
242 ></DIV | |
243 ></BODY | |
244 ></HTML | |
245 > |