Skip to content

Latest commit

 

History

History
1156 lines (1156 loc) · 20.7 KB

index.html

File metadata and controls

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