• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<HTML
2><HEAD
3><TITLE
4>SDL_SetModState</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_GetModState"
17HREF="sdlgetmodstate.html"><LINK
18REL="NEXT"
19TITLE="SDL_GetKeyName"
20HREF="sdlgetkeyname.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="sdlgetmodstate.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="sdlgetkeyname.html"
63ACCESSKEY="N"
64>Next</A
65></TD
66></TR
67></TABLE
68><HR
69ALIGN="LEFT"
70WIDTH="100%"></DIV
71><H1
72><A
73NAME="SDLSETMODSTATE"
74></A
75>SDL_SetModState</H1
76><DIV
77CLASS="REFNAMEDIV"
78><A
79NAME="AEN5752"
80></A
81><H2
82>Name</H2
83>SDL_SetModState&nbsp;--&nbsp;Set the current key modifier state</DIV
84><DIV
85CLASS="REFSYNOPSISDIV"
86><A
87NAME="AEN5755"
88></A
89><H2
90>Synopsis</H2
91><DIV
92CLASS="FUNCSYNOPSIS"
93><A
94NAME="AEN5756"
95></A
96><P
97></P
98><PRE
99CLASS="FUNCSYNOPSISINFO"
100>#include "SDL.h"</PRE
101><P
102><CODE
103><CODE
104CLASS="FUNCDEF"
105>void <B
106CLASS="FSFUNC"
107>SDL_SetModState</B
108></CODE
109>(SDLMod modstate);</CODE
110></P
111><P
112></P
113></DIV
114></DIV
115><DIV
116CLASS="REFSECT1"
117><A
118NAME="AEN5762"
119></A
120><H2
121>Description</H2
122><P
123>The inverse of <A
124HREF="sdlgetmodstate.html"
125><TT
126CLASS="FUNCTION"
127>SDL_GetModState</TT
128></A
129>, <TT
130CLASS="FUNCTION"
131>SDL_SetModState</TT
132> allows you to impose modifier key states on your application.</P
133><P
134>Simply pass your desired modifier states into <TT
135CLASS="PARAMETER"
136><I
137>modstate</I
138></TT
139>. This value my be a logical OR'd combination of the following:</P
140><PRE
141CLASS="PROGRAMLISTING"
142>typedef enum {
143  KMOD_NONE  = 0x0000,
144  KMOD_LSHIFT= 0x0001,
145  KMOD_RSHIFT= 0x0002,
146  KMOD_LCTRL = 0x0040,
147  KMOD_RCTRL = 0x0080,
148  KMOD_LALT  = 0x0100,
149  KMOD_RALT  = 0x0200,
150  KMOD_LMETA = 0x0400,
151  KMOD_RMETA = 0x0800,
152  KMOD_NUM   = 0x1000,
153  KMOD_CAPS  = 0x2000,
154  KMOD_MODE  = 0x4000,
155} SDLMod;</PRE
156></DIV
157><DIV
158CLASS="REFSECT1"
159><A
160NAME="AEN5771"
161></A
162><H2
163>See Also</H2
164><P
165><A
166HREF="sdlgetmodstate.html"
167><TT
168CLASS="FUNCTION"
169>SDL_GetModState</TT
170></A
171></P
172></DIV
173><DIV
174CLASS="NAVFOOTER"
175><HR
176ALIGN="LEFT"
177WIDTH="100%"><TABLE
178SUMMARY="Footer navigation table"
179WIDTH="100%"
180BORDER="0"
181CELLPADDING="0"
182CELLSPACING="0"
183><TR
184><TD
185WIDTH="33%"
186ALIGN="left"
187VALIGN="top"
188><A
189HREF="sdlgetmodstate.html"
190ACCESSKEY="P"
191>Prev</A
192></TD
193><TD
194WIDTH="34%"
195ALIGN="center"
196VALIGN="top"
197><A
198HREF="index.html"
199ACCESSKEY="H"
200>Home</A
201></TD
202><TD
203WIDTH="33%"
204ALIGN="right"
205VALIGN="top"
206><A
207HREF="sdlgetkeyname.html"
208ACCESSKEY="N"
209>Next</A
210></TD
211></TR
212><TR
213><TD
214WIDTH="33%"
215ALIGN="left"
216VALIGN="top"
217>SDL_GetModState</TD
218><TD
219WIDTH="34%"
220ALIGN="center"
221VALIGN="top"
222><A
223HREF="eventfunctions.html"
224ACCESSKEY="U"
225>Up</A
226></TD
227><TD
228WIDTH="33%"
229ALIGN="right"
230VALIGN="top"
231>SDL_GetKeyName</TD
232></TR
233></TABLE
234></DIV
235></BODY
236></HTML
237>