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

<HTML
><HEAD
><TITLE
>SDL_GetAppState</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_GetRelativeMouseState"
HREF="sdlgetrelativemousestate.html"><LINK
REL="NEXT"
TITLE="SDL_JoystickEventState"
HREF="sdljoystickeventstate.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="sdlgetrelativemousestate.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdljoystickeventstate.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLGETAPPSTATE"
></A
>SDL_GetAppState</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5931"
></A
><H2
>Name</H2
><TT
CLASS="FUNCTION"
>SDL_GetAppState</TT
>&nbsp;--&nbsp;Get the state of the application</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5935"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
NAME="AEN5936"
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>Uint8 <B
CLASS="FSFUNC"
>SDL_GetAppState</B
></CODE
>(void);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5942"
></A
><H2
>Description</H2
><P
>This function returns the current state of the application. The value returned is a bitwise combination of:</P
><DIV
CLASS="INFORMALTABLE"
><A
NAME="AEN5945"
></A
><P
></P
><TABLE
BORDER="0"
CLASS="CALSTABLE"
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>SDL_APPMOUSEFOCUS</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The application has mouse focus.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>SDL_APPINPUTFOCUS</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The application has keyboard focus</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
><TT
CLASS="LITERAL"
>SDL_APPACTIVE</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
>The application is visible</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5960"
></A
><H2
>See Also</H2
><P
><A
HREF="sdlactiveevent.html"
><SPAN
CLASS="STRUCTNAME"
>SDL_ActiveEvent</SPAN
></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="sdlgetrelativemousestate.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="sdljoystickeventstate.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetRelativeMouseState</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_JoystickEventState</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>SDL_GetAppState</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_GetRelativeMouseState"
	17	HREF="sdlgetrelativemousestate.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_JoystickEventState"
	20	HREF="sdljoystickeventstate.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="sdlgetrelativemousestate.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="sdljoystickeventstate.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="SDLGETAPPSTATE"
74	></A
75	>SDL_GetAppState</H1
76	><DIV
77	CLASS="REFNAMEDIV"
78	><A
79	NAME="AEN5931"
80	></A
81	><H2
82	>Name</H2
83	><TT
84	CLASS="FUNCTION"
85	>SDL_GetAppState</TT
86	> -- Get the state of the application</DIV
87	><DIV
88	CLASS="REFSYNOPSISDIV"
89	><A
90	NAME="AEN5935"
91	></A
92	><H2
93	>Synopsis</H2
94	><DIV
95	CLASS="FUNCSYNOPSIS"
96	><A
97	NAME="AEN5936"
98	></A
99	><P
100	></P
101	><PRE
102	CLASS="FUNCSYNOPSISINFO"
103	>#include "SDL.h"</PRE
104	><P
105	><CODE
106	><CODE
107	CLASS="FUNCDEF"
108	>Uint8 <B
109	CLASS="FSFUNC"
110	>SDL_GetAppState</B
111	></CODE
112	>(void);</CODE
113	></P
114	><P
115	></P
116	></DIV
117	></DIV
118	><DIV
119	CLASS="REFSECT1"
120	><A
121	NAME="AEN5942"
122	></A
123	><H2
124	>Description</H2
125	><P
126	>This function returns the current state of the application. The value returned is a bitwise combination of:</P
127	><DIV
128	CLASS="INFORMALTABLE"
129	><A
130	NAME="AEN5945"
131	></A
132	><P
133	></P
134	><TABLE
135	BORDER="0"
136	CLASS="CALSTABLE"
137	><TBODY
138	><TR
139	><TD
140	ALIGN="LEFT"
141	VALIGN="TOP"
142	><TT
143	CLASS="LITERAL"
144	>SDL_APPMOUSEFOCUS</TT
145	></TD
146	><TD
147	ALIGN="LEFT"
148	VALIGN="TOP"
149	>The application has mouse focus.</TD
150	></TR
151	><TR
152	><TD
153	ALIGN="LEFT"
154	VALIGN="TOP"
155	><TT
156	CLASS="LITERAL"
157	>SDL_APPINPUTFOCUS</TT
158	></TD
159	><TD
160	ALIGN="LEFT"
161	VALIGN="TOP"
162	>The application has keyboard focus</TD
163	></TR
164	><TR
165	><TD
166	ALIGN="LEFT"
167	VALIGN="TOP"
168	><TT
169	CLASS="LITERAL"
170	>SDL_APPACTIVE</TT
171	></TD
172	><TD
173	ALIGN="LEFT"
174	VALIGN="TOP"
175	>The application is visible</TD
176	></TR
177	></TBODY
178	></TABLE
179	><P
180	></P
181	></DIV
182	></DIV
183	><DIV
184	CLASS="REFSECT1"
185	><A
186	NAME="AEN5960"
187	></A
188	><H2
189	>See Also</H2
190	><P
191	><A
192	HREF="sdlactiveevent.html"
193	><SPAN
194	CLASS="STRUCTNAME"
195	>SDL_ActiveEvent</SPAN
196	></A
197	></P
198	></DIV
199	><DIV
200	CLASS="NAVFOOTER"
201	><HR
202	ALIGN="LEFT"
203	WIDTH="100%"><TABLE
204	SUMMARY="Footer navigation table"
205	WIDTH="100%"
206	BORDER="0"
207	CELLPADDING="0"
208	CELLSPACING="0"
209	><TR
210	><TD
211	WIDTH="33%"
212	ALIGN="left"
213	VALIGN="top"
214	><A
215	HREF="sdlgetrelativemousestate.html"
216	ACCESSKEY="P"
217	>Prev</A
218	></TD
219	><TD
220	WIDTH="34%"
221	ALIGN="center"
222	VALIGN="top"
223	><A
224	HREF="index.html"
225	ACCESSKEY="H"
226	>Home</A
227	></TD
228	><TD
229	WIDTH="33%"
230	ALIGN="right"
231	VALIGN="top"
232	><A
233	HREF="sdljoystickeventstate.html"
234	ACCESSKEY="N"
235	>Next</A
236	></TD
237	></TR
238	><TR
239	><TD
240	WIDTH="33%"
241	ALIGN="left"
242	VALIGN="top"
243	>SDL_GetRelativeMouseState</TD
244	><TD
245	WIDTH="34%"
246	ALIGN="center"
247	VALIGN="top"
248	><A
249	HREF="eventfunctions.html"
250	ACCESSKEY="U"
251	>Up</A
252	></TD
253	><TD
254	WIDTH="33%"
255	ALIGN="right"
256	VALIGN="top"
257	>SDL_JoystickEventState</TD
258	></TR
259	></TABLE
260	></DIV
261	></BODY
262	></HTML
263	>