• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_GetMouseState</TITLE
5><META
6NAME="GENERATOR"
7CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8"><LINK
9REL="HOME"
10TITLE="SDL Library Documentation"
11HREF="index.html"><LINK
12REL="UP"
13TITLE="Event Functions."
14HREF="eventfunctions.html"><LINK
15REL="PREVIOUS"
16TITLE="SDL_EnableKeyRepeat"
17HREF="sdlenablekeyrepeat.html"><LINK
18REL="NEXT"
19TITLE="SDL_GetRelativeMouseState"
20HREF="sdlgetrelativemousestate.html"></HEAD
21><BODY
22CLASS="REFENTRY"
23BGCOLOR="#FFF8DC"
24TEXT="#000000"
25LINK="#0000ee"
26VLINK="#551a8b"
27ALINK="#ff0000"
28><DIV
29CLASS="NAVHEADER"
30><TABLE
31SUMMARY="Header navigation table"
32WIDTH="100%"
33BORDER="0"
34CELLPADDING="0"
35CELLSPACING="0"
36><TR
37><TH
38COLSPAN="3"
39ALIGN="center"
40>SDL Library Documentation</TH
41></TR
42><TR
43><TD
44WIDTH="10%"
45ALIGN="left"
46VALIGN="bottom"
47><A
48HREF="sdlenablekeyrepeat.html"
49ACCESSKEY="P"
50>Prev</A
51></TD
52><TD
53WIDTH="80%"
54ALIGN="center"
55VALIGN="bottom"
56></TD
57><TD
58WIDTH="10%"
59ALIGN="right"
60VALIGN="bottom"
61><A
62HREF="sdlgetrelativemousestate.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLGETMOUSESTATE"
74></A
75>SDL_GetMouseState</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN5869"
80></A
81><H2
82>Name</H2
83>SDL_GetMouseState&nbsp;--&nbsp;Retrieve the current state of the mouse</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN5872"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN5873"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>Uint8 <B
106CLASS="FSFUNC"
107>SDL_GetMouseState</B
108></CODE
109>(int *x, int *y);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN5879"
119></A
120><H2
121>Description</H2
122><P
123>The current button state is returned as a button bitmask, which can
124be tested using the <TT
125CLASS="LITERAL"
126>SDL_BUTTON(X)</TT
127> macros, and <TT
128CLASS="PARAMETER"
129><I
130>x</I
131></TT
132> and <TT
133CLASS="PARAMETER"
134><I
135>y</I
136></TT
137> are set to the
138current mouse cursor position.  You can pass <TT
139CLASS="LITERAL"
140>NULL</TT
141> for either <TT
142CLASS="PARAMETER"
143><I
144>x</I
145></TT
146> or <TT
147CLASS="PARAMETER"
148><I
149>y</I
150></TT
151>.</P
152></DIV
153><DIV
154CLASS="REFSECT1"
155><A
156NAME="AEN5888"
157></A
158><H2
159>Example</H2
160><PRE
161CLASS="PROGRAMLISTING"
162>SDL_PumpEvents();
163if(SDL_GetMouseState(NULL, NULL)&#38;SDL_BUTTON(1))
164  printf("Mouse Button 1(left) is pressed.\n");</PRE
165></DIV
166><DIV
167CLASS="REFSECT1"
168><A
169NAME="AEN5891"
170></A
171><H2
172>See Also</H2
173><P
174><A
175HREF="sdlgetrelativemousestate.html"
176><TT
177CLASS="FUNCTION"
178>SDL_GetRelativeMouseState</TT
179></A
180>,
181<A
182HREF="sdlpumpevents.html"
183><TT
184CLASS="FUNCTION"
185>SDL_PumpEvents</TT
186></A
187></P
188></DIV
189><DIV
190CLASS="NAVFOOTER"
191><HR
192ALIGN="LEFT"
193WIDTH="100%"><TABLE
194SUMMARY="Footer navigation table"
195WIDTH="100%"
196BORDER="0"
197CELLPADDING="0"
198CELLSPACING="0"
199><TR
200><TD
201WIDTH="33%"
202ALIGN="left"
203VALIGN="top"
204><A
205HREF="sdlenablekeyrepeat.html"
206ACCESSKEY="P"
207>Prev</A
208></TD
209><TD
210WIDTH="34%"
211ALIGN="center"
212VALIGN="top"
213><A
214HREF="index.html"
215ACCESSKEY="H"
216>Home</A
217></TD
218><TD
219WIDTH="33%"
220ALIGN="right"
221VALIGN="top"
222><A
223HREF="sdlgetrelativemousestate.html"
224ACCESSKEY="N"
225>Next</A
226></TD
227></TR
228><TR
229><TD
230WIDTH="33%"
231ALIGN="left"
232VALIGN="top"
233>SDL_EnableKeyRepeat</TD
234><TD
235WIDTH="34%"
236ALIGN="center"
237VALIGN="top"
238><A
239HREF="eventfunctions.html"
240ACCESSKEY="U"
241>Up</A
242></TD
243><TD
244WIDTH="33%"
245ALIGN="right"
246VALIGN="top"
247>SDL_GetRelativeMouseState</TD
248></TR
249></TABLE
250></DIV
251></BODY
252></HTML
253>