This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
sdlgetmodstate.html
257 lines (257 loc) · 3.43 KB
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_GetModState</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Event Functions."
HREF="eventfunctions.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GetKeyState"
HREF="sdlgetkeystate.html"><LINK
REL="NEXT"
TITLE="SDL_SetModState"
HREF="sdlsetmodstate.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlgetkeystate.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlsetmodstate.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLGETMODSTATE"
74
75
></A
>SDL_GetModState</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN5721"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_GetModState -- Get the state of modifier keys.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN5724"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN5725"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>SDLMod <B
CLASS="FSFUNC"
>SDL_GetModState</B
></CODE
>(void);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
118
NAME="AEN5731"
119
120
121
122
></A
><H2
>Description</H2
><P
123
>Returns the current state of the modifier keys (CTRL, ALT, etc.).</P
124
125
126
127
></DIV
><DIV
CLASS="REFSECT1"
><A
128
NAME="AEN5734"
129
130
131
132
133
134
135
></A
><H2
>Return Value</H2
><P
>The return value can be an OR'd combination of the SDLMod enum.</P
><P
><A
136
NAME="AEN5738"
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><P
><B
>SDLMod</B
></P
><PRE
CLASS="PROGRAMLISTING"
>typedef enum {
KMOD_NONE = 0x0000,
KMOD_LSHIFT= 0x0001,
KMOD_RSHIFT= 0x0002,
KMOD_LCTRL = 0x0040,
KMOD_RCTRL = 0x0080,
KMOD_LALT = 0x0100,
KMOD_RALT = 0x0200,
KMOD_LMETA = 0x0400,
KMOD_RMETA = 0x0800,
KMOD_NUM = 0x1000,
KMOD_CAPS = 0x2000,
KMOD_MODE = 0x4000,
} SDLMod;</PRE
></BLOCKQUOTE
>
SDL also defines the following symbols for convenience:
<A
164
NAME="AEN5741"
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
><PRE
CLASS="PROGRAMLISTING"
>#define KMOD_CTRL (KMOD_LCTRL|KMOD_RCTRL)
#define KMOD_SHIFT (KMOD_LSHIFT|KMOD_RSHIFT)
#define KMOD_ALT (KMOD_LALT|KMOD_RALT)
#define KMOD_META (KMOD_LMETA|KMOD_RMETA)</PRE
></BLOCKQUOTE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
180
NAME="AEN5743"
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
></A
><H2
>See Also</H2
><P
><A
HREF="sdlgetkeystate.html"
><TT
CLASS="FUNCTION"
>SDL_GetKeyState</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
198
SUMMARY="Footer navigation table"
199
200
201
202
203
204
205
206
207
208
209
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlgetkeystate.html"
210
ACCESSKEY="P"
211
212
213
214
215
216
217
218
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
219
ACCESSKEY="H"
220
221
222
223
224
225
226
227
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlsetmodstate.html"
228
ACCESSKEY="N"
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetKeyState</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="eventfunctions.html"
244
ACCESSKEY="U"
245
246
247
248
249
250
251
252
253
254
255
256
257
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_SetModState</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>