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

<HTML
><HEAD
><TITLE
>SDL_GetKeyState</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_EventState"
HREF="sdleventstate.html"><LINK
REL="NEXT"
TITLE="SDL_GetModState"
HREF="sdlgetmodstate.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="sdleventstate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlgetmodstate.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLGETKEYSTATE"
></A
>SDL_GetKeyState</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5686"
></A
><H2
>Name</H2
>SDL_GetKeyState&nbsp;--&nbsp;Get a snapshot of the current keyboard state</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5689"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN5690"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>Uint8 *<B
CLASS="FSFUNC"
>SDL_GetKeyState</B
></CODE
>(int *numkeys);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5696"
></A
><H2
>Description</H2
><P
>Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in <TT
CLASS="PARAMETER"
><I
>numkeys</I
></TT
>. The array is indexed by the <A
HREF="sdlkey.html"
><TT
CLASS="LITERAL"
>SDLK_*</TT
></A
> symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.</P
><DIV
CLASS="NOTE"
><BLOCKQUOTE
CLASS="NOTE"
><P
><B
>Note: </B
>Use <A
HREF="sdlpumpevents.html"
><TT
CLASS="FUNCTION"
>SDL_PumpEvents</TT
></A
> to update the state array.</P
></BLOCKQUOTE
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5706"
></A
><H2
>Example</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>Uint8 *keystate = SDL_GetKeyState(NULL);
if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.\n");</PRE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5710"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlkey.html"
><TT
CLASS="LITERAL"
>SDL Key Symbols</TT
></A
>,
<A
HREF="sdlpumpevents.html"
><TT
CLASS="FUNCTION"
>SDL_PumpEvents</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="sdleventstate.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="sdlgetmodstate.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_EventState</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_GetModState</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_GetKeyState</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_EventState"
	17	HREF="sdleventstate.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_GetModState"
	20	HREF="sdlgetmodstate.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="sdleventstate.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="sdlgetmodstate.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="SDLGETKEYSTATE"
74	></A
75	>SDL_GetKeyState</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN5686"
80	></A
81	><H2
82	>Name</H2
83	>SDL_GetKeyState -- Get a snapshot of the current keyboard state</DIV
84	><DIV
85	CLASS="REFSYNOPSISDIV"
86	><A
87	NAME="AEN5689"
88	></A
89	><H2
90	>Synopsis</H2
91	><DIV
92	CLASS="FUNCSYNOPSIS"
93	><A
94	NAME="AEN5690"
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	>Uint8 *<B
106	CLASS="FSFUNC"
107	>SDL_GetKeyState</B
108	></CODE
109	>(int *numkeys);</CODE
110	></P
111	><P
112	></P
113	></DIV
114	></DIV
115	><DIV
116	CLASS="REFSECT1"
117	><A
118	NAME="AEN5696"
119	></A
120	><H2
121	>Description</H2
122	><P
123	>Gets a snapshot of the current keyboard state. The current state is return as a pointer to an array, the size of this array is stored in <TT
124	CLASS="PARAMETER"
125	><I
126	>numkeys</I
127	></TT
128	>. The array is indexed by the <A
129	HREF="sdlkey.html"
130	><TT
131	CLASS="LITERAL"
132	>SDLK_*</TT
133	></A
134	> symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.</P
135	><DIV
136	CLASS="NOTE"
137	><BLOCKQUOTE
138	CLASS="NOTE"
139	><P
140	><B
141	>Note: </B
142	>Use <A
143	HREF="sdlpumpevents.html"
144	><TT
145	CLASS="FUNCTION"
146	>SDL_PumpEvents</TT
147	></A
148	> to update the state array.</P
149	></BLOCKQUOTE
150	></DIV
151	></DIV
152	><DIV
153	CLASS="REFSECT1"
154	><A
155	NAME="AEN5706"
156	></A
157	><H2
158	>Example</H2
159	><P
160	><PRE
161	CLASS="PROGRAMLISTING"
162	>Uint8 *keystate = SDL_GetKeyState(NULL);
163	if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed.\n");</PRE
164	></P
165	></DIV
166	><DIV
167	CLASS="REFSECT1"
168	><A
169	NAME="AEN5710"
170	></A
171	><H2
172	>See Also</H2
173	><P
174	><A
175	HREF="sdlkey.html"
176	><TT
177	CLASS="LITERAL"
178	>SDL Key Symbols</TT
179	></A
180	>,
181	<A
182	HREF="sdlpumpevents.html"
183	><TT
184	CLASS="FUNCTION"
185	>SDL_PumpEvents</TT
186	></A
187	></P
188	></DIV
189	><DIV
190	CLASS="NAVFOOTER"
191	><HR
192	ALIGN="LEFT"
193	WIDTH="100%"><TABLE
194	SUMMARY="Footer navigation table"
195	WIDTH="100%"
196	BORDER="0"
197	CELLPADDING="0"
198	CELLSPACING="0"
199	><TR
200	><TD
201	WIDTH="33%"
202	ALIGN="left"
203	VALIGN="top"
204	><A
205	HREF="sdleventstate.html"
206	ACCESSKEY="P"
207	>Prev</A
208	></TD
209	><TD
210	WIDTH="34%"
211	ALIGN="center"
212	VALIGN="top"
213	><A
214	HREF="index.html"
215	ACCESSKEY="H"
216	>Home</A
217	></TD
218	><TD
219	WIDTH="33%"
220	ALIGN="right"
221	VALIGN="top"
222	><A
223	HREF="sdlgetmodstate.html"
224	ACCESSKEY="N"
225	>Next</A
226	></TD
227	></TR
228	><TR
229	><TD
230	WIDTH="33%"
231	ALIGN="left"
232	VALIGN="top"
233	>SDL_EventState</TD
234	><TD
235	WIDTH="34%"
236	ALIGN="center"
237	VALIGN="top"
238	><A
239	HREF="eventfunctions.html"
240	ACCESSKEY="U"
241	>Up</A
242	></TD
243	><TD
244	WIDTH="33%"
245	ALIGN="right"
246	VALIGN="top"
247	>SDL_GetModState</TD
248	></TR
249	></TABLE
250	></DIV
251	></BODY
252	></HTML
253	>