|
1 <HTML |
|
2 ><HEAD |
|
3 ><TITLE |
|
4 >SDL_GetModState</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_GetKeyState" |
|
17 HREF="sdlgetkeystate.html"><LINK |
|
18 REL="NEXT" |
|
19 TITLE="SDL_SetModState" |
|
20 HREF="sdlsetmodstate.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="sdlgetkeystate.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="sdlsetmodstate.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="SDLGETMODSTATE" |
|
74 ></A |
|
75 >SDL_GetModState</H1 |
|
76 ><DIV |
|
77 CLASS="REFNAMEDIV" |
|
78 ><A |
|
79 NAME="AEN5721" |
|
80 ></A |
|
81 ><H2 |
|
82 >Name</H2 |
|
83 >SDL_GetModState -- Get the state of modifier keys.</DIV |
|
84 ><DIV |
|
85 CLASS="REFSYNOPSISDIV" |
|
86 ><A |
|
87 NAME="AEN5724" |
|
88 ></A |
|
89 ><H2 |
|
90 >Synopsis</H2 |
|
91 ><DIV |
|
92 CLASS="FUNCSYNOPSIS" |
|
93 ><A |
|
94 NAME="AEN5725" |
|
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 >SDLMod <B |
|
106 CLASS="FSFUNC" |
|
107 >SDL_GetModState</B |
|
108 ></CODE |
|
109 >(void);</CODE |
|
110 ></P |
|
111 ><P |
|
112 ></P |
|
113 ></DIV |
|
114 ></DIV |
|
115 ><DIV |
|
116 CLASS="REFSECT1" |
|
117 ><A |
|
118 NAME="AEN5731" |
|
119 ></A |
|
120 ><H2 |
|
121 >Description</H2 |
|
122 ><P |
|
123 >Returns the current state of the modifier keys (CTRL, ALT, etc.).</P |
|
124 ></DIV |
|
125 ><DIV |
|
126 CLASS="REFSECT1" |
|
127 ><A |
|
128 NAME="AEN5734" |
|
129 ></A |
|
130 ><H2 |
|
131 >Return Value</H2 |
|
132 ><P |
|
133 >The return value can be an OR'd combination of the SDLMod enum.</P |
|
134 ><P |
|
135 ><A |
|
136 NAME="AEN5738" |
|
137 ></A |
|
138 ><BLOCKQUOTE |
|
139 CLASS="BLOCKQUOTE" |
|
140 ><P |
|
141 ><B |
|
142 >SDLMod</B |
|
143 ></P |
|
144 ><PRE |
|
145 CLASS="PROGRAMLISTING" |
|
146 >typedef enum { |
|
147 KMOD_NONE = 0x0000, |
|
148 KMOD_LSHIFT= 0x0001, |
|
149 KMOD_RSHIFT= 0x0002, |
|
150 KMOD_LCTRL = 0x0040, |
|
151 KMOD_RCTRL = 0x0080, |
|
152 KMOD_LALT = 0x0100, |
|
153 KMOD_RALT = 0x0200, |
|
154 KMOD_LMETA = 0x0400, |
|
155 KMOD_RMETA = 0x0800, |
|
156 KMOD_NUM = 0x1000, |
|
157 KMOD_CAPS = 0x2000, |
|
158 KMOD_MODE = 0x4000, |
|
159 } SDLMod;</PRE |
|
160 ></BLOCKQUOTE |
|
161 > |
|
162 SDL also defines the following symbols for convenience: |
|
163 <A |
|
164 NAME="AEN5741" |
|
165 ></A |
|
166 ><BLOCKQUOTE |
|
167 CLASS="BLOCKQUOTE" |
|
168 ><PRE |
|
169 CLASS="PROGRAMLISTING" |
|
170 >#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL) |
|
171 #define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT) |
|
172 #define KMOD_ALT (KMOD_LALT|KMOD_RALT) |
|
173 #define KMOD_META (KMOD_LMETA|KMOD_RMETA)</PRE |
|
174 ></BLOCKQUOTE |
|
175 ></P |
|
176 ></DIV |
|
177 ><DIV |
|
178 CLASS="REFSECT1" |
|
179 ><A |
|
180 NAME="AEN5743" |
|
181 ></A |
|
182 ><H2 |
|
183 >See Also</H2 |
|
184 ><P |
|
185 ><A |
|
186 HREF="sdlgetkeystate.html" |
|
187 ><TT |
|
188 CLASS="FUNCTION" |
|
189 >SDL_GetKeyState</TT |
|
190 ></A |
|
191 ></P |
|
192 ></DIV |
|
193 ><DIV |
|
194 CLASS="NAVFOOTER" |
|
195 ><HR |
|
196 ALIGN="LEFT" |
|
197 WIDTH="100%"><TABLE |
|
198 SUMMARY="Footer navigation table" |
|
199 WIDTH="100%" |
|
200 BORDER="0" |
|
201 CELLPADDING="0" |
|
202 CELLSPACING="0" |
|
203 ><TR |
|
204 ><TD |
|
205 WIDTH="33%" |
|
206 ALIGN="left" |
|
207 VALIGN="top" |
|
208 ><A |
|
209 HREF="sdlgetkeystate.html" |
|
210 ACCESSKEY="P" |
|
211 >Prev</A |
|
212 ></TD |
|
213 ><TD |
|
214 WIDTH="34%" |
|
215 ALIGN="center" |
|
216 VALIGN="top" |
|
217 ><A |
|
218 HREF="index.html" |
|
219 ACCESSKEY="H" |
|
220 >Home</A |
|
221 ></TD |
|
222 ><TD |
|
223 WIDTH="33%" |
|
224 ALIGN="right" |
|
225 VALIGN="top" |
|
226 ><A |
|
227 HREF="sdlsetmodstate.html" |
|
228 ACCESSKEY="N" |
|
229 >Next</A |
|
230 ></TD |
|
231 ></TR |
|
232 ><TR |
|
233 ><TD |
|
234 WIDTH="33%" |
|
235 ALIGN="left" |
|
236 VALIGN="top" |
|
237 >SDL_GetKeyState</TD |
|
238 ><TD |
|
239 WIDTH="34%" |
|
240 ALIGN="center" |
|
241 VALIGN="top" |
|
242 ><A |
|
243 HREF="eventfunctions.html" |
|
244 ACCESSKEY="U" |
|
245 >Up</A |
|
246 ></TD |
|
247 ><TD |
|
248 WIDTH="33%" |
|
249 ALIGN="right" |
|
250 VALIGN="top" |
|
251 >SDL_SetModState</TD |
|
252 ></TR |
|
253 ></TABLE |
|
254 ></DIV |
|
255 ></BODY |
|
256 ></HTML |
|
257 > |