SDL-1.2.14
[sdl_omap.git] / docs / html / general.html
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 >&nbsp;--&nbsp;Initializes SDL</DT
94 ><DT
95 ><A
96 HREF="sdlinitsubsystem.html"
97 >SDL_InitSubSystem</A
98 >&nbsp;--&nbsp;Initialize subsystems</DT
99 ><DT
100 ><A
101 HREF="sdlquitsubsystem.html"
102 >SDL_QuitSubSystem</A
103 >&nbsp;--&nbsp;Shut down a subsystem</DT
104 ><DT
105 ><A
106 HREF="sdlquit.html"
107 >SDL_Quit</A
108 >&nbsp;--&nbsp;Shut down SDL</DT
109 ><DT
110 ><A
111 HREF="sdlwasinit.html"
112 >SDL_WasInit</A
113 >&nbsp;--&nbsp;Check which subsystems are initialized</DT
114 ><DT
115 ><A
116 HREF="sdlgeterror.html"
117 >SDL_GetError</A
118 >&nbsp;--&nbsp;Get SDL error string</DT
119 ><DT
120 ><A
121 HREF="sdlenvvars.html"
122 >SDL_envvars</A
123 >&nbsp;--&nbsp;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 >