|
0
|
1 <HTML
|
|
|
2 ><HEAD
|
|
|
3 ><TITLE
|
|
|
4 ></TITLE
|
|
|
5 ><META
|
|
|
6 NAME="GENERATOR"
|
|
|
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.61
|
|
|
8 "><LINK
|
|
|
9 REL="NEXT"
|
|
|
10 TITLE="SDL Guide"
|
|
|
11 HREF="guide.html"></HEAD
|
|
|
12 ><BODY
|
|
|
13 CLASS="BOOK"
|
|
|
14 BGCOLOR="#FFF8DC"
|
|
|
15 TEXT="#000000"
|
|
|
16 LINK="#0000ee"
|
|
|
17 VLINK="#551a8b"
|
|
|
18 ALINK="#ff0000"
|
|
|
19 ><DIV
|
|
|
20 CLASS="BOOK"
|
|
|
21 ><A
|
|
|
22 NAME="AEN1"
|
|
|
23 ></A
|
|
|
24 ><DIV
|
|
|
25 CLASS="TOC"
|
|
|
26 ><DL
|
|
|
27 ><DT
|
|
|
28 ><B
|
|
|
29 >Table of Contents</B
|
|
|
30 ></DT
|
|
|
31 ><DT
|
|
|
32 >I. <A
|
|
|
33 HREF="guide.html"
|
|
|
34 >SDL Guide</A
|
|
|
35 ></DT
|
|
|
36 ><DD
|
|
|
37 ><DL
|
|
|
38 ><DT
|
|
|
39 ><A
|
|
|
40 HREF="guidepreface.html"
|
|
|
41 >Preface</A
|
|
|
42 ></DT
|
|
|
43 ><DD
|
|
|
44 ><DL
|
|
|
45 ><DT
|
|
|
46 ><A
|
|
|
47 HREF="guidepreface.html#GUIDEABOUTSDL"
|
|
|
48 >About SDL</A
|
|
|
49 ></DT
|
|
|
50 ><DT
|
|
|
51 ><A
|
|
|
52 HREF="guideaboutsdldoc.html"
|
|
|
53 >About SDLdoc</A
|
|
|
54 ></DT
|
|
|
55 ><DT
|
|
|
56 ><A
|
|
|
57 HREF="guidecredits.html"
|
|
|
58 >Credits</A
|
|
|
59 ></DT
|
|
|
60 ></DL
|
|
|
61 ></DD
|
|
|
62 ><DT
|
|
|
63 >1. <A
|
|
|
64 HREF="guidethebasics.html"
|
|
|
65 >The Basics</A
|
|
|
66 ></DT
|
|
|
67 ><DD
|
|
|
68 ><DL
|
|
|
69 ><DT
|
|
|
70 ><A
|
|
|
71 HREF="guidethebasics.html#GUIDEINTRODUCTION"
|
|
|
72 >Introduction</A
|
|
|
73 ></DT
|
|
|
74 ><DT
|
|
|
75 ><A
|
|
|
76 HREF="guidebasicsinit.html"
|
|
|
77 >Initializing SDL</A
|
|
|
78 ></DT
|
|
|
79 ></DL
|
|
|
80 ></DD
|
|
|
81 ><DT
|
|
|
82 >2. <A
|
|
|
83 HREF="guidevideo.html"
|
|
|
84 >Graphics and Video</A
|
|
|
85 ></DT
|
|
|
86 ><DD
|
|
|
87 ><DL
|
|
|
88 ><DT
|
|
|
89 ><A
|
|
|
90 HREF="guidevideo.html#GUIDEVIDEOOPENGL"
|
|
|
91 >Using OpenGL With SDL</A
|
|
|
92 ></DT
|
|
|
93 ></DL
|
|
|
94 ></DD
|
|
|
95 ><DT
|
|
|
96 >3. <A
|
|
|
97 HREF="guideinput.html"
|
|
|
98 >Input handling</A
|
|
|
99 ></DT
|
|
|
100 ><DD
|
|
|
101 ><DL
|
|
|
102 ><DT
|
|
|
103 ><A
|
|
|
104 HREF="guideinput.html#GUIDEINPUTJOYSTICK"
|
|
|
105 >Handling Joysticks</A
|
|
|
106 ></DT
|
|
|
107 ><DT
|
|
|
108 ><A
|
|
|
109 HREF="guideinputkeyboard.html"
|
|
|
110 >Handling the Keyboard</A
|
|
|
111 ></DT
|
|
|
112 ></DL
|
|
|
113 ></DD
|
|
|
114 ><DT
|
|
|
115 >4. <A
|
|
|
116 HREF="guideexamples.html"
|
|
|
117 >Examples</A
|
|
|
118 ></DT
|
|
|
119 ><DD
|
|
|
120 ><DL
|
|
|
121 ><DT
|
|
|
122 ><A
|
|
|
123 HREF="guideexamples.html#AEN297"
|
|
|
124 >Introduction</A
|
|
|
125 ></DT
|
|
|
126 ><DT
|
|
|
127 ><A
|
|
|
128 HREF="guidevideoexamples.html"
|
|
|
129 >Video Examples</A
|
|
|
130 ></DT
|
|
|
131 ><DT
|
|
|
132 ><A
|
|
|
133 HREF="guideeventexamples.html"
|
|
|
134 >Event Examples</A
|
|
|
135 ></DT
|
|
|
136 ><DT
|
|
|
137 ><A
|
|
|
138 HREF="guideaudioexamples.html"
|
|
|
139 >Audio Examples</A
|
|
|
140 ></DT
|
|
|
141 ><DT
|
|
|
142 ><A
|
|
|
143 HREF="guidecdromexamples.html"
|
|
|
144 >CDROM Examples</A
|
|
|
145 ></DT
|
|
|
146 ><DT
|
|
|
147 ><A
|
|
|
148 HREF="guidetimeexamples.html"
|
|
|
149 >Time Examples</A
|
|
|
150 ></DT
|
|
|
151 ></DL
|
|
|
152 ></DD
|
|
|
153 ></DL
|
|
|
154 ></DD
|
|
|
155 ><DT
|
|
|
156 >II. <A
|
|
|
157 HREF="reference.html"
|
|
|
158 >SDL Reference</A
|
|
|
159 ></DT
|
|
|
160 ><DD
|
|
|
161 ><DL
|
|
|
162 ><DT
|
|
|
163 >5. <A
|
|
|
164 HREF="general.html"
|
|
|
165 >General</A
|
|
|
166 ></DT
|
|
|
167 ><DD
|
|
|
168 ><DL
|
|
|
169 ><DT
|
|
|
170 ><A
|
|
|
171 HREF="sdlinit.html"
|
|
|
172 >SDL_Init</A
|
|
|
173 > — Initializes SDL</DT
|
|
|
174 ><DT
|
|
|
175 ><A
|
|
|
176 HREF="sdlinitsubsystem.html"
|
|
|
177 >SDL_InitSubSystem</A
|
|
|
178 > — Initialize subsystems</DT
|
|
|
179 ><DT
|
|
|
180 ><A
|
|
|
181 HREF="sdlquitsubsystem.html"
|
|
|
182 >SDL_QuitSubSystem</A
|
|
|
183 > — Shut down a subsystem</DT
|
|
|
184 ><DT
|
|
|
185 ><A
|
|
|
186 HREF="sdlquit.html"
|
|
|
187 >SDL_Quit</A
|
|
|
188 > — Shut down SDL</DT
|
|
|
189 ><DT
|
|
|
190 ><A
|
|
|
191 HREF="sdlwasinit.html"
|
|
|
192 >SDL_WasInit</A
|
|
|
193 > — Check which subsystems are initialized</DT
|
|
|
194 ></DL
|
|
|
195 ></DD
|
|
|
196 ><DT
|
|
|
197 >6. <A
|
|
|
198 HREF="video.html"
|
|
|
199 >Video</A
|
|
|
200 ></DT
|
|
|
201 ><DD
|
|
|
202 ><DL
|
|
|
203 ><DT
|
|
|
204 ><A
|
|
|
205 HREF="sdlgetvideosurface.html"
|
|
|
206 >SDL_GetVideoSurface</A
|
|
|
207 > — returns a pointer to the current display surface</DT
|
|
|
208 ><DT
|
|
|
209 ><A
|
|
|
210 HREF="sdlgetvideoinfo.html"
|
|
|
211 >SDL_GetVideoInfo</A
|
|
|
212 > — returns a pointer to information about the video hardware</DT
|
|
|
213 ><DT
|
|
|
214 ><A
|
|
|
215 HREF="sdlvideodrivername.html"
|
|
|
216 >SDL_VideoDriverName</A
|
|
|
217 > — Obtain the name of the video driver</DT
|
|
|
218 ><DT
|
|
|
219 ><A
|
|
|
220 HREF="sdllistmodes.html"
|
|
|
221 >SDL_ListModes</A
|
|
|
222 > — Returns a pointer to an array of available screen dimensions for
|
|
|
223 the given format and video flags</DT
|
|
|
224 ><DT
|
|
|
225 ><A
|
|
|
226 HREF="sdlvideomodeok.html"
|
|
|
227 >SDL_VideoModeOK</A
|
|
|
228 > — Check to see if a particular video mode is supported.</DT
|
|
|
229 ><DT
|
|
|
230 ><A
|
|
|
231 HREF="sdlsetvideomode.html"
|
|
|
232 >SDL_SetVideoMode</A
|
|
|
233 > — Set up a video mode with the specified width, height and bits-per-pixel.</DT
|
|
|
234 ><DT
|
|
|
235 ><A
|
|
|
236 HREF="sdlupdaterect.html"
|
|
|
237 >SDL_UpdateRect</A
|
|
|
238 > — Makes sure the given area is updated on the given screen.</DT
|
|
|
239 ><DT
|
|
|
240 ><A
|
|
|
241 HREF="sdlupdaterects.html"
|
|
|
242 >SDL_UpdateRects</A
|
|
|
243 > — Makes sure the given list of rectangles is updated on the given screen.</DT
|
|
|
244 ><DT
|
|
|
245 ><A
|
|
|
246 HREF="sdlflip.html"
|
|
|
247 >SDL_Flip</A
|
|
|
248 > — Swaps screen buffers</DT
|
|
|
249 ><DT
|
|
|
250 ><A
|
|
|
251 HREF="sdlsetcolors.html"
|
|
|
252 >SDL_SetColors</A
|
|
|
253 > — Sets a portion of the colormap for the given 8-bit surface.</DT
|
|
|
254 ><DT
|
|
|
255 ><A
|
|
|
256 HREF="sdlsetpalette.html"
|
|
|
257 >SDL_SetPalette</A
|
|
|
258 > — Sets the colors in the palette of an 8-bit surface.</DT
|
|
|
259 ><DT
|
|
|
260 ><A
|
|
|
261 HREF="sdlsetgamma.html"
|
|
|
262 >SDL_SetGamma</A
|
|
|
263 > — Sets the color gamma function for the display</DT
|
|
|
264 ><DT
|
|
|
265 ><A
|
|
|
266 HREF="sdlgetgammaramp.html"
|
|
|
267 >SDL_GetGammaRamp</A
|
|
|
268 > — Gets the color gamma lookup tables for the display</DT
|
|
|
269 ><DT
|
|
|
270 ><A
|
|
|
271 HREF="sdlsetgammaramp.html"
|
|
|
272 >SDL_SetGammaRamp</A
|
|
|
273 > — Sets the color gamma lookup tables for the display</DT
|
|
|
274 ><DT
|
|
|
275 ><A
|
|
|
276 HREF="sdlmaprgb.html"
|
|
|
277 >SDL_MapRGB</A
|
|
|
278 > — Map a RGB color value to a pixel format.</DT
|
|
|
279 ><DT
|
|
|
280 ><A
|
|
|
281 HREF="sdlmaprgba.html"
|
|
|
282 >SDL_MapRGBA</A
|
|
|
283 > — Map a RGBA color value to a pixel format.</DT
|
|
|
284 ><DT
|
|
|
285 ><A
|
|
|
286 HREF="sdlgetrgb.html"
|
|
|
287 >SDL_GetRGB</A
|
|
|
288 > — Get RGB values from a pixel in the specified pixel format.</DT
|
|
|
289 ><DT
|
|
|
290 ><A
|
|
|
291 HREF="sdlgetrgba.html"
|
|
|
292 >SDL_GetRGBA</A
|
|
|
293 > — Get RGBA values from a pixel in the specified pixel format.</DT
|
|
|
294 ><DT
|
|
|
295 ><A
|
|
|
296 HREF="sdlcreatergbsurface.html"
|
|
|
297 >SDL_CreateRGBSurface</A
|
|
|
298 > — Create an empty SDL_Surface</DT
|
|
|
299 ><DT
|
|
|
300 ><A
|
|
|
301 HREF="sdlcreatergbsurfacefrom.html"
|
|
|
302 >SDL_CreateRGBSurfaceFrom</A
|
|
|
303 > — Create an SDL_Surface from pixel data</DT
|
|
|
304 ><DT
|
|
|
305 ><A
|
|
|
306 HREF="sdlfreesurface.html"
|
|
|
307 >SDL_FreeSurface</A
|
|
|
308 > — Frees (deletes) and SDL_Surface</DT
|
|
|
309 ><DT
|
|
|
310 ><A
|
|
|
311 HREF="sdllocksurface.html"
|
|
|
312 >SDL_LockSurface</A
|
|
|
313 > — Lock a surface for directly access.</DT
|
|
|
314 ><DT
|
|
|
315 ><A
|
|
|
316 HREF="sdlunlocksurface.html"
|
|
|
317 >SDL_UnlockSurface</A
|
|
|
318 > — Unlocks a previously locked surface.</DT
|
|
|
319 ><DT
|
|
|
320 ><A
|
|
|
321 HREF="sdlloadbmp.html"
|
|
|
322 >SDL_LoadBMP</A
|
|
|
323 > — Load a Windows BMP file into an SDL_Surface.</DT
|
|
|
324 ><DT
|
|
|
325 ><A
|
|
|
326 HREF="sdlsavebmp.html"
|
|
|
327 >SDL_SaveBMP</A
|
|
|
328 > — Save an SDL_Surface as a Windows BMP file.</DT
|
|
|
329 ><DT
|
|
|
330 ><A
|
|
|
331 HREF="sdlsetcolorkey.html"
|
|
|
332 >SDL_SetColorKey</A
|
|
|
333 > — Sets the color key (transparent pixel) in a blittable surface and
|
|
|
334 RLE acceleration.</DT
|
|
|
335 ><DT
|
|
|
336 ><A
|
|
|
337 HREF="sdlsetalpha.html"
|
|
|
338 >SDL_SetAlpha</A
|
|
|
339 > — Adjust the alpha properties of a surface</DT
|
|
|
340 ><DT
|
|
|
341 ><A
|
|
|
342 HREF="sdlsetcliprect.html"
|
|
|
343 >SDL_SetClipRect</A
|
|
|
344 > — Sets the clipping rectangle for a surface.</DT
|
|
|
345 ><DT
|
|
|
346 ><A
|
|
|
347 HREF="sdlgetcliprect.html"
|
|
|
348 >SDL_GetClipRect</A
|
|
|
349 > — Gets the clipping rectangle for a surface.</DT
|
|
|
350 ><DT
|
|
|
351 ><A
|
|
|
352 HREF="sdlconvertsurface.html"
|
|
|
353 >SDL_ConvertSurface</A
|
|
|
354 > — Converts a surface to the same format as another surface.</DT
|
|
|
355 ><DT
|
|
|
356 ><A
|
|
|
357 HREF="sdlblitsurface.html"
|
|
|
358 >SDL_BlitSurface</A
|
|
|
359 > — This performs a fast blit from the source surface to the destination surface.</DT
|
|
|
360 ><DT
|
|
|
361 ><A
|
|
|
362 HREF="sdlfillrect.html"
|
|
|
363 >SDL_FillRect</A
|
|
|
364 > — This function performs a fast fill of the given rectangle with some color</DT
|
|
|
365 ><DT
|
|
|
366 ><A
|
|
|
367 HREF="sdldisplayformat.html"
|
|
|
368 >SDL_DisplayFormat</A
|
|
|
369 > — Convert a surface to the display format</DT
|
|
|
370 ><DT
|
|
|
371 ><A
|
|
|
372 HREF="sdldisplayformatalpha.html"
|
|
|
373 >SDL_DisplayFormatAlpha</A
|
|
|
374 > — Convert a surface to the display format</DT
|
|
|
375 ><DT
|
|
|
376 ><A
|
|
|
377 HREF="sdlwarpmouse.html"
|
|
|
378 >SDL_WarpMouse</A
|
|
|
379 > — Set the position of the mouse cursor.</DT
|
|
|
380 ><DT
|
|
|
381 ><A
|
|
|
382 HREF="sdlcreatecursor.html"
|
|
|
383 >SDL_CreateCursor</A
|
|
|
384 > — Creates a new mouse cursor.</DT
|
|
|
385 ><DT
|
|
|
386 ><A
|
|
|
387 HREF="sdlfreecursor.html"
|
|
|
388 >SDL_FreeCursor</A
|
|
|
389 > — Frees a cursor created with SDL_CreateCursor.</DT
|
|
|
390 ><DT
|
|
|
391 ><A
|
|
|
392 HREF="sdlsetcursor.html"
|
|
|
393 >SDL_SetCursor</A
|
|
|
394 > — Set the currently active mouse cursor.</DT
|
|
|
395 ><DT
|
|
|
396 ><A
|
|
|
397 HREF="sdlgetcursor.html"
|
|
|
398 >SDL_GetCursor</A
|
|
|
399 > — Get the currently active mouse cursor.</DT
|
|
|
400 ><DT
|
|
|
401 ><A
|
|
|
402 HREF="sdlshowcursor.html"
|
|
|
403 >SDL_ShowCursor</A
|
|
|
404 > — Toggle whether or not the cursor is shown on the screen.</DT
|
|
|
405 ><DT
|
|
|
406 ><A
|
|
|
407 HREF="sdlglloadlibrary.html"
|
|
|
408 >SDL_GL_LoadLibrary</A
|
|
|
409 > — Specify an OpenGL library</DT
|
|
|
410 ><DT
|
|
|
411 ><A
|
|
|
412 HREF="sdlglgetprocaddress.html"
|
|
|
413 >SDL_GL_GetProcAddress</A
|
|
|
414 > — Get the address of a GL function</DT
|
|
|
415 ><DT
|
|
|
416 ><A
|
|
|
417 HREF="sdlglgetattribute.html"
|
|
|
418 >SDL_GL_GetAttribute</A
|
|
|
419 > — Get the value of a special SDL/OpenGL attribute</DT
|
|
|
420 ><DT
|
|
|
421 ><A
|
|
|
422 HREF="sdlglsetattribute.html"
|
|
|
423 >SDL_GL_SetAttribute</A
|
|
|
424 > — Set a special SDL/OpenGL attribute</DT
|
|
|
425 ><DT
|
|
|
426 ><A
|
|
|
427 HREF="sdlglswapbuffers.html"
|
|
|
428 >SDL_GL_SwapBuffers</A
|
|
|
429 > — Swap OpenGL framebuffers/Update Display</DT
|
|
|
430 ><DT
|
|
|
431 ><A
|
|
|
432 HREF="sdlcreateyuvoverlay.html"
|
|
|
433 >SDL_CreateYUVOverlay</A
|
|
|
434 > — Create a YUV video overlay</DT
|
|
|
435 ><DT
|
|
|
436 ><A
|
|
|
437 HREF="sdllockyuvoverlay.html"
|
|
|
438 >SDL_LockYUVOverlay</A
|
|
|
439 > — Lock an overlay</DT
|
|
|
440 ><DT
|
|
|
441 ><A
|
|
|
442 HREF="sdlunlockyuvoverlay.html"
|
|
|
443 >SDL_UnlockYUVOverlay</A
|
|
|
444 > — Unlock an overlay</DT
|
|
|
445 ><DT
|
|
|
446 ><A
|
|
|
447 HREF="sdldisplayyuvoverlay.html"
|
|
|
448 >SDL_DisplayYUVOverlay</A
|
|
|
449 > — Blit the overlay to the display</DT
|
|
|
450 ><DT
|
|
|
451 ><A
|
|
|
452 HREF="sdlfreeyuvoverlay.html"
|
|
|
453 >SDL_FreeYUVOverlay</A
|
|
|
454 > — Free a YUV video overlay</DT
|
|
|
455 ><DT
|
|
|
456 ><A
|
|
|
457 HREF="sdlglattr.html"
|
|
|
458 >SDL_GLattr</A
|
|
|
459 > — SDL GL Attributes</DT
|
|
|
460 ><DT
|
|
|
461 ><A
|
|
|
462 HREF="sdlrect.html"
|
|
|
463 >SDL_Rect</A
|
|
|
464 > — Defines a rectangular area</DT
|
|
|
465 ><DT
|
|
|
466 ><A
|
|
|
467 HREF="sdlcolor.html"
|
|
|
468 >SDL_Color</A
|
|
|
469 > — Format independent color description</DT
|
|
|
470 ><DT
|
|
|
471 ><A
|
|
|
472 HREF="sdlpalette.html"
|
|
|
473 >SDL_Palette</A
|
|
|
474 > — Color palette for 8-bit pixel formats</DT
|
|
|
475 ><DT
|
|
|
476 ><A
|
|
|
477 HREF="sdlpixelformat.html"
|
|
|
478 >SDL_PixelFormat</A
|
|
|
479 > — Stores surface format information</DT
|
|
|
480 ><DT
|
|
|
481 ><A
|
|
|
482 HREF="sdlsurface.html"
|
|
|
483 >SDL_Surface</A
|
|
|
484 > — Graphical Surface Structure</DT
|
|
|
485 ><DT
|
|
|
486 ><A
|
|
|
487 HREF="sdlvideoinfo.html"
|
|
|
488 >SDL_VideoInfo</A
|
|
|
489 > — Video Target information</DT
|
|
|
490 ><DT
|
|
|
491 ><A
|
|
|
492 HREF="sdloverlay.html"
|
|
|
493 >SDL_Overlay</A
|
|
|
494 > — YUV video overlay</DT
|
|
|
495 ></DL
|
|
|
496 ></DD
|
|
|
497 ><DT
|
|
|
498 >7. <A
|
|
|
499 HREF="wm.html"
|
|
|
500 >Window Management</A
|
|
|
501 ></DT
|
|
|
502 ><DD
|
|
|
503 ><DL
|
|
|
504 ><DT
|
|
|
505 ><A
|
|
|
506 HREF="sdlwmsetcaption.html"
|
|
|
507 >SDL_WM_SetCaption</A
|
|
|
508 > — Sets the window tile and icon name.</DT
|
|
|
509 ><DT
|
|
|
510 ><A
|
|
|
511 HREF="sdlwmgetcaption.html"
|
|
|
512 >SDL_WM_GetCaption</A
|
|
|
513 > — Gets the window title and icon name.</DT
|
|
|
514 ><DT
|
|
|
515 ><A
|
|
|
516 HREF="sdlwmseticon.html"
|
|
|
517 >SDL_WM_SetIcon</A
|
|
|
518 > — Sets the icon for the display window.</DT
|
|
|
519 ><DT
|
|
|
520 ><A
|
|
|
521 HREF="sdlwmiconifywindow.html"
|
|
|
522 >SDL_WM_IconifyWindow</A
|
|
|
523 > — Iconify/Minimise the window</DT
|
|
|
524 ><DT
|
|
|
525 ><A
|
|
|
526 HREF="sdlwmtogglefullscreen.html"
|
|
|
527 >SDL_WM_ToggleFullScreen</A
|
|
|
528 > — Toggles fullscreen mode</DT
|
|
|
529 ><DT
|
|
|
530 ><A
|
|
|
531 HREF="sdlwmgrabinput.html"
|
|
|
532 >SDL_WM_GrabInput</A
|
|
|
533 > — Grabs mouse and keyboard input.</DT
|
|
|
534 ></DL
|
|
|
535 ></DD
|
|
|
536 ><DT
|
|
|
537 >8. <A
|
|
|
538 HREF="event.html"
|
|
|
539 >Events</A
|
|
|
540 ></DT
|
|
|
541 ><DD
|
|
|
542 ><DL
|
|
|
543 ><DT
|
|
|
544 ><A
|
|
|
545 HREF="event.html#AEN3194"
|
|
|
546 >Introduction</A
|
|
|
547 ></DT
|
|
|
548 ><DT
|
|
|
549 ><A
|
|
|
550 HREF="eventstructures.html"
|
|
|
551 >SDL Event Structures.</A
|
|
|
552 ></DT
|
|
|
553 ><DT
|
|
|
554 ><A
|
|
|
555 HREF="eventfunctions.html"
|
|
|
556 >Event Functions.</A
|
|
|
557 ></DT
|
|
|
558 ></DL
|
|
|
559 ></DD
|
|
|
560 ><DT
|
|
|
561 >9. <A
|
|
|
562 HREF="joystick.html"
|
|
|
563 >Joystick</A
|
|
|
564 ></DT
|
|
|
565 ><DD
|
|
|
566 ><DL
|
|
|
567 ><DT
|
|
|
568 ><A
|
|
|
569 HREF="sdlnumjoysticks.html"
|
|
|
570 >SDL_NumJoysticks</A
|
|
|
571 > — Count available joysticks.</DT
|
|
|
572 ><DT
|
|
|
573 ><A
|
|
|
574 HREF="sdljoystickname.html"
|
|
|
575 >SDL_JoystickName</A
|
|
|
576 > — Get joystick name.</DT
|
|
|
577 ><DT
|
|
|
578 ><A
|
|
|
579 HREF="sdljoystickopen.html"
|
|
|
580 >SDL_JoystickOpen</A
|
|
|
581 > — Opens a joystick for use.</DT
|
|
|
582 ><DT
|
|
|
583 ><A
|
|
|
584 HREF="sdljoystickopened.html"
|
|
|
585 >SDL_JoystickOpened</A
|
|
|
586 > — Determine if a joystick has been opened</DT
|
|
|
587 ><DT
|
|
|
588 ><A
|
|
|
589 HREF="sdljoystickindex.html"
|
|
|
590 >SDL_JoystickIndex</A
|
|
|
591 > — Get the index of an SDL_Joystick.</DT
|
|
|
592 ><DT
|
|
|
593 ><A
|
|
|
594 HREF="sdljoysticknumaxes.html"
|
|
|
595 >SDL_JoystickNumAxes</A
|
|
|
596 > — Get the number of joystick axes</DT
|
|
|
597 ><DT
|
|
|
598 ><A
|
|
|
599 HREF="sdljoysticknumballs.html"
|
|
|
600 >SDL_JoystickNumBalls</A
|
|
|
601 > — Get the number of joystick trackballs</DT
|
|
|
602 ><DT
|
|
|
603 ><A
|
|
|
604 HREF="sdljoysticknumhats.html"
|
|
|
605 >SDL_JoystickNumHats</A
|
|
|
606 > — Get the number of joystick hats</DT
|
|
|
607 ><DT
|
|
|
608 ><A
|
|
|
609 HREF="sdljoysticknumbuttons.html"
|
|
|
610 >SDL_JoystickNumButtons</A
|
|
|
611 > — Get the number of joysitck buttons</DT
|
|
|
612 ><DT
|
|
|
613 ><A
|
|
|
614 HREF="sdljoystickupdate.html"
|
|
|
615 >SDL_JoystickUpdate</A
|
|
|
616 > — Updates the state of all joysticks</DT
|
|
|
617 ><DT
|
|
|
618 ><A
|
|
|
619 HREF="sdljoystickgetaxis.html"
|
|
|
620 >SDL_JoystickGetAxis</A
|
|
|
621 > — Get the current state of an axis</DT
|
|
|
622 ><DT
|
|
|
623 ><A
|
|
|
624 HREF="sdljoystickgethat.html"
|
|
|
625 >SDL_JoystickGetHat</A
|
|
|
626 > — Get the current state of a joystick hat</DT
|
|
|
627 ><DT
|
|
|
628 ><A
|
|
|
629 HREF="sdljoystickgetbutton.html"
|
|
|
630 >SDL_JoystickGetButton</A
|
|
|
631 > — Get the current state of a given button on a given joystick</DT
|
|
|
632 ><DT
|
|
|
633 ><A
|
|
|
634 HREF="sdljoystickgetball.html"
|
|
|
635 >SDL_JoystickGetBall</A
|
|
|
636 > — Get relative trackball motion</DT
|
|
|
637 ><DT
|
|
|
638 ><A
|
|
|
639 HREF="sdljoystickclose.html"
|
|
|
640 >SDL_JoystickClose</A
|
|
|
641 > — Closes a previously opened joystick</DT
|
|
|
642 ></DL
|
|
|
643 ></DD
|
|
|
644 ><DT
|
|
|
645 >10. <A
|
|
|
646 HREF="audio.html"
|
|
|
647 >Audio</A
|
|
|
648 ></DT
|
|
|
649 ><DD
|
|
|
650 ><DL
|
|
|
651 ><DT
|
|
|
652 ><A
|
|
|
653 HREF="sdlaudiospec.html"
|
|
|
654 >SDL_AudioSpec</A
|
|
|
655 > — Audio Specification Structure</DT
|
|
|
656 ><DT
|
|
|
657 ><A
|
|
|
658 HREF="sdlopenaudio.html"
|
|
|
659 >SDL_OpenAudio</A
|
|
|
660 > — Opens the audio device with the desired parameters.</DT
|
|
|
661 ><DT
|
|
|
662 ><A
|
|
|
663 HREF="sdlpauseaudio.html"
|
|
|
664 >SDL_PauseAudio</A
|
|
|
665 > — Pauses and unpauses the audio callback processing</DT
|
|
|
666 ><DT
|
|
|
667 ><A
|
|
|
668 HREF="sdlgetaudiostatus.html"
|
|
|
669 >SDL_GetAudioStatus</A
|
|
|
670 > — Get the current audio state</DT
|
|
|
671 ><DT
|
|
|
672 ><A
|
|
|
673 HREF="sdlloadwav.html"
|
|
|
674 >SDL_LoadWAV</A
|
|
|
675 > — Load a WAVE file</DT
|
|
|
676 ><DT
|
|
|
677 ><A
|
|
|
678 HREF="sdlfreewav.html"
|
|
|
679 >SDL_FreeWAV</A
|
|
|
680 > — Frees previously opened WAV data</DT
|
|
|
681 ><DT
|
|
|
682 ><A
|
|
|
683 HREF="sdlaudiocvt.html"
|
|
|
684 >SDL_AudioCVT</A
|
|
|
685 > — Audio Conversion Structure</DT
|
|
|
686 ><DT
|
|
|
687 ><A
|
|
|
688 HREF="sdlbuildaudiocvt.html"
|
|
|
689 >SDL_BuildAudioCVT</A
|
|
|
690 > — Initializes a SDL_AudioCVT structure for conversion</DT
|
|
|
691 ><DT
|
|
|
692 ><A
|
|
|
693 HREF="sdlconvertaudio.html"
|
|
|
694 >SDL_ConvertAudio</A
|
|
|
695 > — Convert audio data to a desired audio format.</DT
|
|
|
696 ><DT
|
|
|
697 ><A
|
|
|
698 HREF="sdlmixaudio.html"
|
|
|
699 >SDL_MixAudio</A
|
|
|
700 > — Mix audio data</DT
|
|
|
701 ><DT
|
|
|
702 ><A
|
|
|
703 HREF="sdllockaudio.html"
|
|
|
704 >SDL_LockAudio</A
|
|
|
705 > — Lock out the callback function</DT
|
|
|
706 ><DT
|
|
|
707 ><A
|
|
|
708 HREF="sdlunlockaudio.html"
|
|
|
709 >SDL_UnlockAudio</A
|
|
|
710 > — Unlock the callback function</DT
|
|
|
711 ><DT
|
|
|
712 ><A
|
|
|
713 HREF="sdlcloseaudio.html"
|
|
|
714 >SDL_CloseAudio</A
|
|
|
715 > — Shuts down audio processing and closes the audio device.</DT
|
|
|
716 ></DL
|
|
|
717 ></DD
|
|
|
718 ><DT
|
|
|
719 >11. <A
|
|
|
720 HREF="cdrom.html"
|
|
|
721 >CD-ROM</A
|
|
|
722 ></DT
|
|
|
723 ><DD
|
|
|
724 ><DL
|
|
|
725 ><DT
|
|
|
726 ><A
|
|
|
727 HREF="sdlcdnumdrives.html"
|
|
|
728 >SDL_CDNumDrives</A
|
|
|
729 > — Returns the number of CD-ROM drives on the system.</DT
|
|
|
730 ><DT
|
|
|
731 ><A
|
|
|
732 HREF="sdlcdname.html"
|
|
|
733 >SDL_CDName</A
|
|
|
734 > — Returns a human-readable, system-dependent identifier for the CD-ROM.</DT
|
|
|
735 ><DT
|
|
|
736 ><A
|
|
|
737 HREF="sdlcdopen.html"
|
|
|
738 >SDL_CDOpen</A
|
|
|
739 > — Opens a CD-ROM drive for access.</DT
|
|
|
740 ><DT
|
|
|
741 ><A
|
|
|
742 HREF="sdlcdstatus.html"
|
|
|
743 >SDL_CDStatus</A
|
|
|
744 > — Returns the current status of the given drive.</DT
|
|
|
745 ><DT
|
|
|
746 ><A
|
|
|
747 HREF="sdlcdplay.html"
|
|
|
748 >SDL_CDPlay</A
|
|
|
749 > — Play a CD</DT
|
|
|
750 ><DT
|
|
|
751 ><A
|
|
|
752 HREF="sdlcdplaytracks.html"
|
|
|
753 >SDL_CDPlayTracks</A
|
|
|
754 > — Play the given CD track(s)</DT
|
|
|
755 ><DT
|
|
|
756 ><A
|
|
|
757 HREF="sdlcdpause.html"
|
|
|
758 >SDL_CDPause</A
|
|
|
759 > — Pauses a CDROM</DT
|
|
|
760 ><DT
|
|
|
761 ><A
|
|
|
762 HREF="sdlcdresume.html"
|
|
|
763 >SDL_CDResume</A
|
|
|
764 > — Resumes a CDROM</DT
|
|
|
765 ><DT
|
|
|
766 ><A
|
|
|
767 HREF="sdlcdstop.html"
|
|
|
768 >SDL_CDStop</A
|
|
|
769 > — Stops a CDROM</DT
|
|
|
770 ><DT
|
|
|
771 ><A
|
|
|
772 HREF="sdlcdeject.html"
|
|
|
773 >SDL_CDEject</A
|
|
|
774 > — Ejects a CDROM</DT
|
|
|
775 ><DT
|
|
|
776 ><A
|
|
|
777 HREF="sdlcdclose.html"
|
|
|
778 >SDL_CDClose</A
|
|
|
779 > — Closes a SDL_CD handle</DT
|
|
|
780 ><DT
|
|
|
781 ><A
|
|
|
782 HREF="sdlcd.html"
|
|
|
783 >SDL_CD</A
|
|
|
784 > — CDROM Drive Information</DT
|
|
|
785 ><DT
|
|
|
786 ><A
|
|
|
787 HREF="sdlcdtrack.html"
|
|
|
788 >SDL_CDtrack</A
|
|
|
789 > — CD Track Information Structure</DT
|
|
|
790 ></DL
|
|
|
791 ></DD
|
|
|
792 ><DT
|
|
|
793 >12. <A
|
|
|
794 HREF="thread.html"
|
|
|
795 >Multi-threaded Programming</A
|
|
|
796 ></DT
|
|
|
797 ><DD
|
|
|
798 ><DL
|
|
|
799 ><DT
|
|
|
800 ><A
|
|
|
801 HREF="sdlcreatethread.html"
|
|
|
802 >SDL_CreateThread</A
|
|
|
803 > — Creates a new thread of execution that shares its parent's properties.</DT
|
|
|
804 ><DT
|
|
|
805 ><A
|
|
|
806 HREF="sdlthreadid.html"
|
|
|
807 >SDL_ThreadID</A
|
|
|
808 > — Get the 32-bit thread identifier for the current thread.</DT
|
|
|
809 ><DT
|
|
|
810 ><A
|
|
|
811 HREF="sdlgetthreadid.html"
|
|
|
812 >SDL_GetThreadID</A
|
|
|
813 > — Get the SDL thread ID of a SDL_Thread</DT
|
|
|
814 ><DT
|
|
|
815 ><A
|
|
|
816 HREF="sdlwaitthread.html"
|
|
|
817 >SDL_WaitThread</A
|
|
|
818 > — Wait for a thread to finish.</DT
|
|
|
819 ><DT
|
|
|
820 ><A
|
|
|
821 HREF="sdlkillthread.html"
|
|
|
822 >SDL_KillThread</A
|
|
|
823 > — Gracelessly terminates the thread.</DT
|
|
|
824 ><DT
|
|
|
825 ><A
|
|
|
826 HREF="sdlcreatemutex.html"
|
|
|
827 >SDL_CreateMutex</A
|
|
|
828 > — Create a mutex</DT
|
|
|
829 ><DT
|
|
|
830 ><A
|
|
|
831 HREF="sdldestroymutex.html"
|
|
|
832 >SDL_DestroyMutex</A
|
|
|
833 > — Destroy a mutex</DT
|
|
|
834 ><DT
|
|
|
835 ><A
|
|
|
836 HREF="sdlmutexp.html"
|
|
|
837 >SDL_mutexP</A
|
|
|
838 > — Lock a mutex</DT
|
|
|
839 ><DT
|
|
|
840 ><A
|
|
|
841 HREF="sdlmutexv.html"
|
|
|
842 >SDL_mutexV</A
|
|
|
843 > — Unlock a mutex</DT
|
|
|
844 ><DT
|
|
|
845 ><A
|
|
|
846 HREF="sdlcreatesemaphore.html"
|
|
|
847 >SDL_CreateSemaphore</A
|
|
|
848 > — Creates a new semaphore and assigns an initial value to it.</DT
|
|
|
849 ><DT
|
|
|
850 ><A
|
|
|
851 HREF="sdldestroysemaphore.html"
|
|
|
852 >SDL_DestroySemaphore</A
|
|
|
853 > — Destroys a semaphore that was created by <A
|
|
|
854 HREF="sdlcreatesemaphore.html"
|
|
|
855 >SDL_CreateSemaphore</A
|
|
|
856 >.</DT
|
|
|
857 ><DT
|
|
|
858 ><A
|
|
|
859 HREF="sdlsemwait.html"
|
|
|
860 >SDL_SemWait</A
|
|
|
861 > — Lock a semaphore and suspend the thread if the semaphore value is zero.</DT
|
|
|
862 ><DT
|
|
|
863 ><A
|
|
|
864 HREF="sdlsemtrywait.html"
|
|
|
865 >SDL_SemTryWait</A
|
|
|
866 > — Attempt to lock a semaphore but don't suspend the thread.</DT
|
|
|
867 ><DT
|
|
|
868 ><A
|
|
|
869 HREF="sdlsemwaittimeout.html"
|
|
|
870 >SDL_SemWaitTimeout</A
|
|
|
871 > — Lock a semaphore, but only wait up to a specified maximum time.</DT
|
|
|
872 ><DT
|
|
|
873 ><A
|
|
|
874 HREF="sdlsempost.html"
|
|
|
875 >SDL_SemPost</A
|
|
|
876 > — Unlock a semaphore.</DT
|
|
|
877 ><DT
|
|
|
878 ><A
|
|
|
879 HREF="sdlsemvalue.html"
|
|
|
880 >SDL_SemValue</A
|
|
|
881 > — Return the current value of a semaphore.</DT
|
|
|
882 ><DT
|
|
|
883 ><A
|
|
|
884 HREF="sdlcreatecond.html"
|
|
|
885 >SDL_CreateCond</A
|
|
|
886 > — Create a condition variable</DT
|
|
|
887 ><DT
|
|
|
888 ><A
|
|
|
889 HREF="sdldestroycond.html"
|
|
|
890 >SDL_DestroyCond</A
|
|
|
891 > — Destroy a condition variable</DT
|
|
|
892 ><DT
|
|
|
893 ><A
|
|
|
894 HREF="sdlcondsignal.html"
|
|
|
895 >SDL_CondSignal</A
|
|
|
896 > — Restart a thread wait on a condition variable</DT
|
|
|
897 ><DT
|
|
|
898 ><A
|
|
|
899 HREF="sdlcondbroadcast.html"
|
|
|
900 >SDL_CondBroadcast</A
|
|
|
901 > — Restart all threads waiting on a condition variable</DT
|
|
|
902 ><DT
|
|
|
903 ><A
|
|
|
904 HREF="sdlcondwait.html"
|
|
|
905 >SDL_CondWait</A
|
|
|
906 > — Wait on a condition variable</DT
|
|
|
907 ><DT
|
|
|
908 ><A
|
|
|
909 HREF="sdlcondwaittimeout.html"
|
|
|
910 >SDL_CondWaitTimeout</A
|
|
|
911 > — Wait on a condition variable, with timeout</DT
|
|
|
912 ></DL
|
|
|
913 ></DD
|
|
|
914 ><DT
|
|
|
915 >13. <A
|
|
|
916 HREF="time.html"
|
|
|
917 >Time</A
|
|
|
918 ></DT
|
|
|
919 ><DD
|
|
|
920 ><DL
|
|
|
921 ><DT
|
|
|
922 ><A
|
|
|
923 HREF="sdlgetticks.html"
|
|
|
924 >SDL_GetTicks</A
|
|
|
925 > — Get the number of milliseconds since the SDL library initialization.</DT
|
|
|
926 ><DT
|
|
|
927 ><A
|
|
|
928 HREF="sdldelay.html"
|
|
|
929 >SDL_Delay</A
|
|
|
930 > — Wait a specified number of milliseconds before returning.</DT
|
|
|
931 ><DT
|
|
|
932 ><A
|
|
|
933 HREF="sdladdtimer.html"
|
|
|
934 >SDL_AddTimer</A
|
|
|
935 > — Add a timer which will call a callback after the specified number of milliseconds has
|
|
|
936 elapsed.</DT
|
|
|
937 ><DT
|
|
|
938 ><A
|
|
|
939 HREF="sdlremovetimer.html"
|
|
|
940 >SDL_RemoveTimer</A
|
|
|
941 > — Remove a timer which was added with
|
|
|
942 <A
|
|
|
943 HREF="sdladdtimer.html"
|
|
|
944 >SDL_AddTimer</A
|
|
|
945 >.</DT
|
|
|
946 ><DT
|
|
|
947 ><A
|
|
|
948 HREF="sdlsettimer.html"
|
|
|
949 >SDL_SetTimer</A
|
|
|
950 > — Set a callback to run after the specified number of milliseconds has
|
|
|
951 elapsed.</DT
|
|
|
952 ></DL
|
|
|
953 ></DD
|
|
|
954 ></DL
|
|
|
955 ></DD
|
|
|
956 ></DL
|
|
|
957 ></DIV
|
|
|
958 ><DIV
|
|
|
959 CLASS="LOT"
|
|
|
960 ><DL
|
|
|
961 CLASS="LOT"
|
|
|
962 ><DT
|
|
|
963 ><B
|
|
|
964 >List of Tables</B
|
|
|
965 ></DT
|
|
|
966 ><DT
|
|
|
967 >8-1. <A
|
|
|
968 HREF="sdlkey.html#AEN4177"
|
|
|
969 >SDL Keysym definitions</A
|
|
|
970 ></DT
|
|
|
971 ><DT
|
|
|
972 >8-2. <A
|
|
|
973 HREF="sdlkey.html#SDLMOD"
|
|
|
974 >SDL modifier definitions</A
|
|
|
975 ></DT
|
|
|
976 ></DL
|
|
|
977 ></DIV
|
|
|
978 ><DIV
|
|
|
979 CLASS="LOT"
|
|
|
980 ><DL
|
|
|
981 CLASS="LOT"
|
|
|
982 ><DT
|
|
|
983 ><B
|
|
|
984 >List of Examples</B
|
|
|
985 ></DT
|
|
|
986 ><DT
|
|
|
987 >2-1. <A
|
|
|
988 HREF="guidevideo.html#AEN87"
|
|
|
989 >gl.c - SDL OpenGL Example</A
|
|
|
990 ></DT
|
|
|
991 ><DT
|
|
|
992 >3-1. <A
|
|
|
993 HREF="guideinputkeyboard.html#AEN282"
|
|
|
994 >keys.c - Key event information</A
|
|
|
995 ></DT
|
|
|
996 ></DL
|
|
|
997 ></DIV
|
|
|
998 ></DIV
|
|
|
999 ><DIV
|
|
|
1000 CLASS="NAVFOOTER"
|
|
|
1001 ><HR
|
|
|
1002 ALIGN="LEFT"
|
|
|
1003 WIDTH="100%"><TABLE
|
|
|
1004 WIDTH="100%"
|
|
|
1005 BORDER="0"
|
|
|
1006 CELLPADDING="0"
|
|
|
1007 CELLSPACING="0"
|
|
|
1008 ><TR
|
|
|
1009 ><TD
|
|
|
1010 WIDTH="33%"
|
|
|
1011 ALIGN="left"
|
|
|
1012 VALIGN="top"
|
|
|
1013 > </TD
|
|
|
1014 ><TD
|
|
|
1015 WIDTH="34%"
|
|
|
1016 ALIGN="center"
|
|
|
1017 VALIGN="top"
|
|
|
1018 > </TD
|
|
|
1019 ><TD
|
|
|
1020 WIDTH="33%"
|
|
|
1021 ALIGN="right"
|
|
|
1022 VALIGN="top"
|
|
|
1023 ><A
|
|
|
1024 HREF="guide.html"
|
|
|
1025 >Next</A
|
|
|
1026 ></TD
|
|
|
1027 ></TR
|
|
|
1028 ><TR
|
|
|
1029 ><TD
|
|
|
1030 WIDTH="33%"
|
|
|
1031 ALIGN="left"
|
|
|
1032 VALIGN="top"
|
|
|
1033 > </TD
|
|
|
1034 ><TD
|
|
|
1035 WIDTH="34%"
|
|
|
1036 ALIGN="center"
|
|
|
1037 VALIGN="top"
|
|
|
1038 > </TD
|
|
|
1039 ><TD
|
|
|
1040 WIDTH="33%"
|
|
|
1041 ALIGN="right"
|
|
|
1042 VALIGN="top"
|
|
|
1043 >SDL Guide</TD
|
|
|
1044 ></TR
|
|
|
1045 ></TABLE
|
|
|
1046 ></DIV
|
|
|
1047 ></BODY
|
|
|
1048 ></HTML
|
|
|
1049 > |
