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

<HTML
><HEAD
><TITLE
>General</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="SDL Reference"
HREF="reference.html"><LINK
REL="PREVIOUS"
TITLE="SDL Reference"
HREF="reference.html"><LINK
REL="NEXT"
TITLE="SDL_Init"
HREF="sdlinit.html"><META
NAME="KEYWORD"
CONTENT="general"><META
NAME="KEYWORD"
CONTENT="function"></HEAD
><BODY
CLASS="CHAPTER"
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="reference.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlinit.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="GENERAL"
></A
>Chapter 5. General</H1
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="sdlinit.html"
>SDL_Init</A
>&nbsp;--&nbsp;Initializes SDL</DT
><DT
><A
HREF="sdlinitsubsystem.html"
>SDL_InitSubSystem</A
>&nbsp;--&nbsp;Initialize subsystems</DT
><DT
><A
HREF="sdlquitsubsystem.html"
>SDL_QuitSubSystem</A
>&nbsp;--&nbsp;Shut down a subsystem</DT
><DT
><A
HREF="sdlquit.html"
>SDL_Quit</A
>&nbsp;--&nbsp;Shut down SDL</DT
><DT
><A
HREF="sdlwasinit.html"
>SDL_WasInit</A
>&nbsp;--&nbsp;Check which subsystems are initialized</DT
><DT
><A
HREF="sdlgeterror.html"
>SDL_GetError</A
>&nbsp;--&nbsp;Get SDL error string</DT
><DT
><A
HREF="sdlenvvars.html"
>SDL_envvars</A
>&nbsp;--&nbsp;SDL environment variables</DT
></DL
></DIV
><P
>Before SDL can be used in a program it must be initialized with <A
HREF="sdlinit.html"
><TT
CLASS="FUNCTION"
>SDL_Init</TT
></A
>. <TT
CLASS="FUNCTION"
>SDL_Init</TT
> initializes all the subsystems that the user requests (video, audio, joystick, timers and/or cdrom). Once SDL is initialized with <TT
CLASS="FUNCTION"
>SDL_Init</TT
> subsystems can be shut down and initialized as needed using <A
HREF="sdlinitsubsystem.html"
><TT
CLASS="FUNCTION"
>SDL_InitSubSystem</TT
></A
> and <A
HREF="sdlquitsubsystem.html"
><TT
CLASS="FUNCTION"
>SDL_QuitSubSystem</TT
></A
>.</P
><P
>SDL must also be shut down before the program exits to make sure it cleans up correctly. Calling <A
HREF="sdlquit.html"
><TT
CLASS="FUNCTION"
>SDL_Quit</TT
></A
> shuts down all subsystems and frees any resources allocated to SDL.</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="reference.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="sdlinit.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL Reference</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="reference.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_Init</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Commit	Line	Data
e14743d1	1	<HTML
	2	><HEAD
	3	><TITLE
	4	>General</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="SDL Reference"
	14	HREF="reference.html"><LINK
	15	REL="PREVIOUS"
	16	TITLE="SDL Reference"
	17	HREF="reference.html"><LINK
	18	REL="NEXT"
	19	TITLE="SDL_Init"
	20	HREF="sdlinit.html"><META
	21	NAME="KEYWORD"
	22	CONTENT="general"><META
	23	NAME="KEYWORD"
	24	CONTENT="function"></HEAD
	25	><BODY
	26	CLASS="CHAPTER"
	27	BGCOLOR="#FFF8DC"
	28	TEXT="#000000"
	29	LINK="#0000ee"
	30	VLINK="#551a8b"
	31	ALINK="#ff0000"
	32	><DIV
	33	CLASS="NAVHEADER"
	34	><TABLE
	35	SUMMARY="Header navigation table"
	36	WIDTH="100%"
	37	BORDER="0"
	38	CELLPADDING="0"
	39	CELLSPACING="0"
	40	><TR
	41	><TH
	42	COLSPAN="3"
	43	ALIGN="center"
	44	>SDL Library Documentation</TH
	45	></TR
	46	><TR
	47	><TD
	48	WIDTH="10%"
	49	ALIGN="left"
	50	VALIGN="bottom"
	51	><A
	52	HREF="reference.html"
	53	ACCESSKEY="P"
	54	>Prev</A
	55	></TD
	56	><TD
	57	WIDTH="80%"
	58	ALIGN="center"
	59	VALIGN="bottom"
	60	></TD
	61	><TD
	62	WIDTH="10%"
	63	ALIGN="right"
	64	VALIGN="bottom"
65	><A
66	HREF="sdlinit.html"
67	ACCESSKEY="N"
68	>Next</A
69	></TD
70	></TR
71	></TABLE
72	><HR
73	ALIGN="LEFT"
74	WIDTH="100%"></DIV
75	><DIV
76	CLASS="CHAPTER"
77	><H1
78	><A
79	NAME="GENERAL"
80	></A
81	>Chapter 5. General</H1
82	><DIV
83	CLASS="TOC"
84	><DL
85	><DT
86	><B
87	>Table of Contents</B
88	></DT
89	><DT
90	><A
91	HREF="sdlinit.html"
92	>SDL_Init</A
93	> -- Initializes SDL</DT
94	><DT
95	><A
96	HREF="sdlinitsubsystem.html"
97	>SDL_InitSubSystem</A
98	> -- Initialize subsystems</DT
99	><DT
100	><A
101	HREF="sdlquitsubsystem.html"
102	>SDL_QuitSubSystem</A
103	> -- Shut down a subsystem</DT
104	><DT
105	><A
106	HREF="sdlquit.html"
107	>SDL_Quit</A
108	> -- Shut down SDL</DT
109	><DT
110	><A
111	HREF="sdlwasinit.html"
112	>SDL_WasInit</A
113	> -- Check which subsystems are initialized</DT
114	><DT
115	><A
116	HREF="sdlgeterror.html"
117	>SDL_GetError</A
118	> -- Get SDL error string</DT
119	><DT
120	><A
121	HREF="sdlenvvars.html"
122	>SDL_envvars</A
123	> -- SDL environment variables</DT
124	></DL
125	></DIV
126	><P
127	>Before SDL can be used in a program it must be initialized with <A
128	HREF="sdlinit.html"
129	><TT
130	CLASS="FUNCTION"
131	>SDL_Init</TT
132	></A
133	>. <TT
134	CLASS="FUNCTION"
135	>SDL_Init</TT
136	> initializes all the subsystems that the user requests (video, audio, joystick, timers and/or cdrom). Once SDL is initialized with <TT
137	CLASS="FUNCTION"
138	>SDL_Init</TT
139	> subsystems can be shut down and initialized as needed using <A
140	HREF="sdlinitsubsystem.html"
141	><TT
142	CLASS="FUNCTION"
143	>SDL_InitSubSystem</TT
144	></A
145	> and <A
146	HREF="sdlquitsubsystem.html"
147	><TT
148	CLASS="FUNCTION"
149	>SDL_QuitSubSystem</TT
150	></A
151	>.</P
152	><P
153	>SDL must also be shut down before the program exits to make sure it cleans up correctly. Calling <A
154	HREF="sdlquit.html"
155	><TT
156	CLASS="FUNCTION"
157	>SDL_Quit</TT
158	></A
159	> shuts down all subsystems and frees any resources allocated to SDL.</P
160	></DIV
161	><DIV
162	CLASS="NAVFOOTER"
163	><HR
164	ALIGN="LEFT"
165	WIDTH="100%"><TABLE
166	SUMMARY="Footer navigation table"
167	WIDTH="100%"
168	BORDER="0"
169	CELLPADDING="0"
170	CELLSPACING="0"
171	><TR
172	><TD
173	WIDTH="33%"
174	ALIGN="left"
175	VALIGN="top"
176	><A
177	HREF="reference.html"
178	ACCESSKEY="P"
179	>Prev</A
180	></TD
181	><TD
182	WIDTH="34%"
183	ALIGN="center"
184	VALIGN="top"
185	><A
186	HREF="index.html"
187	ACCESSKEY="H"
188	>Home</A
189	></TD
190	><TD
191	WIDTH="33%"
192	ALIGN="right"
193	VALIGN="top"
194	><A
195	HREF="sdlinit.html"
196	ACCESSKEY="N"
197	>Next</A
198	></TD
199	></TR
200	><TR
201	><TD
202	WIDTH="33%"
203	ALIGN="left"
204	VALIGN="top"
205	>SDL Reference</TD
206	><TD
207	WIDTH="34%"
208	ALIGN="center"
209	VALIGN="top"
210	><A
211	HREF="reference.html"
212	ACCESSKEY="U"
213	>Up</A
214	></TD
215	><TD
216	WIDTH="33%"
217	ALIGN="right"
218	VALIGN="top"
219	>SDL_Init</TD
220	></TR
221	></TABLE
222	></DIV
223	></BODY
224	></HTML
225	>