[sdl_omap.git] / docs / html / sdlsetmodstate.html

<HTML
><HEAD
><TITLE
>SDL_SetModState</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Event Functions."
HREF="eventfunctions.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GetModState"
HREF="sdlgetmodstate.html"><LINK
REL="NEXT"
TITLE="SDL_GetKeyName"
HREF="sdlgetkeyname.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
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="sdlgetmodstate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlgetkeyname.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLSETMODSTATE"
></A
>SDL_SetModState</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5752"
></A
><H2
>Name</H2
>SDL_SetModState&nbsp;--&nbsp;Set the current key modifier state</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5755"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN5756"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <B
CLASS="FSFUNC"
>SDL_SetModState</B
></CODE
>(SDLMod modstate);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5762"
></A
><H2
>Description</H2
><P
>The inverse of <A
HREF="sdlgetmodstate.html"
><TT
CLASS="FUNCTION"
>SDL_GetModState</TT
></A
>, <TT
CLASS="FUNCTION"
>SDL_SetModState</TT
> allows you to impose modifier key states on your application.</P
><P
>Simply pass your desired modifier states into <TT
CLASS="PARAMETER"
><I
>modstate</I
></TT
>. This value my be a logical OR'd combination of the following:</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
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5771"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlgetmodstate.html"
><TT
CLASS="FUNCTION"
>SDL_GetModState</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlgetmodstate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlgetkeyname.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetModState</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="eventfunctions.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_GetKeyName</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_SetModState</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_GetModState"
	17	HREF="sdlgetmodstate.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_GetKeyName"
	20	HREF="sdlgetkeyname.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="sdlgetmodstate.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="sdlgetkeyname.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="SDLSETMODSTATE"
74	></A
75	>SDL_SetModState</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN5752"
80	></A
81	><H2
82	>Name</H2
83	>SDL_SetModState -- Set the current key modifier state</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN5755"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN5756"
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	>void <B
106	CLASS="FSFUNC"
107	>SDL_SetModState</B
108	></CODE
109	>(SDLMod modstate);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN5762"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>The inverse of <A
124	HREF="sdlgetmodstate.html"
125	><TT
126	CLASS="FUNCTION"
127	>SDL_GetModState</TT
128	></A
129	>, <TT
130	CLASS="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
135	CLASS="PARAMETER"
136	><I
137	>modstate</I
138	></TT
139	>. This value my be a logical OR'd combination of the following:</P
140	><PRE
141	CLASS="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
158	CLASS="REFSECT1"
159	><A
160	NAME="AEN5771"
161	></A
162	><H2
163	>See Also</H2
164	><P
165	><A
166	HREF="sdlgetmodstate.html"
167	><TT
168	CLASS="FUNCTION"
169	>SDL_GetModState</TT
170	></A
171	></P
172	></DIV
173	><DIV
174	CLASS="NAVFOOTER"
175	><HR
176	ALIGN="LEFT"
177	WIDTH="100%"><TABLE
178	SUMMARY="Footer navigation table"
179	WIDTH="100%"
180	BORDER="0"
181	CELLPADDING="0"
182	CELLSPACING="0"
183	><TR
184	><TD
185	WIDTH="33%"
186	ALIGN="left"
187	VALIGN="top"
188	><A
189	HREF="sdlgetmodstate.html"
190	ACCESSKEY="P"
191	>Prev</A
192	></TD
193	><TD
194	WIDTH="34%"
195	ALIGN="center"
196	VALIGN="top"
197	><A
198	HREF="index.html"
199	ACCESSKEY="H"
200	>Home</A
201	></TD
202	><TD
203	WIDTH="33%"
204	ALIGN="right"
205	VALIGN="top"
206	><A
207	HREF="sdlgetkeyname.html"
208	ACCESSKEY="N"
209	>Next</A
210	></TD
211	></TR
212	><TR
213	><TD
214	WIDTH="33%"
215	ALIGN="left"
216	VALIGN="top"
217	>SDL_GetModState</TD
218	><TD
219	WIDTH="34%"
220	ALIGN="center"
221	VALIGN="top"
222	><A
223	HREF="eventfunctions.html"
224	ACCESSKEY="U"
225	>Up</A
226	></TD
227	><TD
228	WIDTH="33%"
229	ALIGN="right"
230	VALIGN="top"
231	>SDL_GetKeyName</TD
232	></TR
233	></TABLE
234	></DIV
235	></BODY
236	></HTML
237	>