7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
11 HREF="guide.html"></HEAD
40 HREF="guidepreface.html"
47 HREF="guidepreface.html#GUIDEABOUTSDL"
52 HREF="guideaboutsdldoc.html"
57 HREF="guidecredits.html"
64 HREF="guidethebasics.html"
71 HREF="guidethebasics.html#GUIDEINTRODUCTION"
76 HREF="guidebasicsinit.html"
83 HREF="guidevideo.html"
84 >Graphics and Video</A
90 HREF="guidevideo.html#GUIDEVIDEOINTRO"
91 >Introduction to SDL Video</A
95 HREF="guidevideoopengl.html"
96 >Using OpenGL With SDL</A
102 HREF="guideinput.html"
109 HREF="guideinput.html#GUIDEINPUTJOYSTICK"
110 >Handling Joysticks</A
114 HREF="guideinputkeyboard.html"
115 >Handling the Keyboard</A
121 HREF="guideexamples.html"
128 HREF="guideexamples.html#AEN369"
133 HREF="guideeventexamples.html"
138 HREF="guideaudioexamples.html"
143 HREF="guidecdromexamples.html"
148 HREF="guidetimeexamples.html"
157 HREF="reference.html"
173 > -- Initializes SDL</DT
176 HREF="sdlinitsubsystem.html"
177 >SDL_InitSubSystem</A
178 > -- Initialize subsystems</DT
181 HREF="sdlquitsubsystem.html"
182 >SDL_QuitSubSystem</A
183 > -- Shut down a subsystem</DT
188 > -- Shut down SDL</DT
191 HREF="sdlwasinit.html"
193 > -- Check which subsystems are initialized</DT
196 HREF="sdlgeterror.html"
198 > -- Get SDL error string</DT
201 HREF="sdlenvvars.html"
203 > -- SDL environment variables</DT
215 HREF="sdlgetvideosurface.html"
216 >SDL_GetVideoSurface</A
217 > -- returns a pointer to the current display surface</DT
220 HREF="sdlgetvideoinfo.html"
222 > -- returns a pointer to information about the video hardware</DT
225 HREF="sdlvideodrivername.html"
226 >SDL_VideoDriverName</A
227 > -- Obtain the name of the video driver</DT
230 HREF="sdllistmodes.html"
232 > -- Returns a pointer to an array of available screen dimensions for
233 the given format and video flags</DT
236 HREF="sdlvideomodeok.html"
238 > -- Check to see if a particular video mode is supported.</DT
241 HREF="sdlsetvideomode.html"
243 > -- Set up a video mode with the specified width, height and bits-per-pixel.</DT
246 HREF="sdlupdaterect.html"
248 > -- Makes sure the given area is updated on the given screen.</DT
251 HREF="sdlupdaterects.html"
253 > -- Makes sure the given list of rectangles is updated on the given screen.</DT
258 > -- Swaps screen buffers</DT
261 HREF="sdlsetcolors.html"
263 > -- Sets a portion of the colormap for the given 8-bit surface.</DT
266 HREF="sdlsetpalette.html"
268 > -- Sets the colors in the palette of an 8-bit surface.</DT
271 HREF="sdlsetgamma.html"
273 > -- Sets the color gamma function for the display</DT
276 HREF="sdlgetgammaramp.html"
278 > -- Gets the color gamma lookup tables for the display</DT
281 HREF="sdlsetgammaramp.html"
283 > -- Sets the color gamma lookup tables for the display</DT
286 HREF="sdlmaprgb.html"
288 > -- Map a RGB color value to a pixel format.</DT
291 HREF="sdlmaprgba.html"
293 > -- Map a RGBA color value to a pixel format.</DT
296 HREF="sdlgetrgb.html"
298 > -- Get RGB values from a pixel in the specified pixel format.</DT
301 HREF="sdlgetrgba.html"
303 > -- Get RGBA values from a pixel in the specified pixel format.</DT
306 HREF="sdlcreatergbsurface.html"
307 >SDL_CreateRGBSurface</A
308 > -- Create an empty SDL_Surface</DT
311 HREF="sdlcreatergbsurfacefrom.html"
312 >SDL_CreateRGBSurfaceFrom</A
313 > -- Create an SDL_Surface from pixel data</DT
316 HREF="sdlfreesurface.html"
318 > -- Frees (deletes) a SDL_Surface</DT
321 HREF="sdllocksurface.html"
323 > -- Lock a surface for directly access.</DT
326 HREF="sdlunlocksurface.html"
327 >SDL_UnlockSurface</A
328 > -- Unlocks a previously locked surface.</DT
331 HREF="sdlloadbmp.html"
333 > -- Load a Windows BMP file into an SDL_Surface.</DT
336 HREF="sdlsavebmp.html"
338 > -- Save an SDL_Surface as a Windows BMP file.</DT
341 HREF="sdlsetcolorkey.html"
343 > -- Sets the color key (transparent pixel) in a blittable surface and
344 RLE acceleration.</DT
347 HREF="sdlsetalpha.html"
349 > -- Adjust the alpha properties of a surface</DT
352 HREF="sdlsetcliprect.html"
354 > -- Sets the clipping rectangle for a surface.</DT
357 HREF="sdlgetcliprect.html"
359 > -- Gets the clipping rectangle for a surface.</DT
362 HREF="sdlconvertsurface.html"
363 >SDL_ConvertSurface</A
364 > -- Converts a surface to the same format as another surface.</DT
367 HREF="sdlblitsurface.html"
369 > -- This performs a fast blit from the source surface to the destination surface.</DT
372 HREF="sdlfillrect.html"
374 > -- This function performs a fast fill of the given rectangle with some color</DT
377 HREF="sdldisplayformat.html"
378 >SDL_DisplayFormat</A
379 > -- Convert a surface to the display format</DT
382 HREF="sdldisplayformatalpha.html"
383 >SDL_DisplayFormatAlpha</A
384 > -- Convert a surface to the display format</DT
387 HREF="sdlwarpmouse.html"
389 > -- Set the position of the mouse cursor.</DT
392 HREF="sdlcreatecursor.html"
394 > -- Creates a new mouse cursor.</DT
397 HREF="sdlfreecursor.html"
399 > -- Frees a cursor created with SDL_CreateCursor.</DT
402 HREF="sdlsetcursor.html"
404 > -- Set the currently active mouse cursor.</DT
407 HREF="sdlgetcursor.html"
409 > -- Get the currently active mouse cursor.</DT
412 HREF="sdlshowcursor.html"
414 > -- Toggle whether or not the cursor is shown on the screen.</DT
417 HREF="sdlglloadlibrary.html"
418 >SDL_GL_LoadLibrary</A
419 > -- Specify an OpenGL library</DT
422 HREF="sdlglgetprocaddress.html"
423 >SDL_GL_GetProcAddress</A
424 > -- Get the address of a GL function</DT
427 HREF="sdlglgetattribute.html"
428 >SDL_GL_GetAttribute</A
429 > -- Get the value of a special SDL/OpenGL attribute</DT
432 HREF="sdlglsetattribute.html"
433 >SDL_GL_SetAttribute</A
434 > -- Set a special SDL/OpenGL attribute</DT
437 HREF="sdlglswapbuffers.html"
438 >SDL_GL_SwapBuffers</A
439 > -- Swap OpenGL framebuffers/Update Display</DT
442 HREF="sdlcreateyuvoverlay.html"
443 >SDL_CreateYUVOverlay</A
444 > -- Create a YUV video overlay</DT
447 HREF="sdllockyuvoverlay.html"
448 >SDL_LockYUVOverlay</A
449 > -- Lock an overlay</DT
452 HREF="sdlunlockyuvoverlay.html"
453 >SDL_UnlockYUVOverlay</A
454 > -- Unlock an overlay</DT
457 HREF="sdldisplayyuvoverlay.html"
458 >SDL_DisplayYUVOverlay</A
459 > -- Blit the overlay to the display</DT
462 HREF="sdlfreeyuvoverlay.html"
463 >SDL_FreeYUVOverlay</A
464 > -- Free a YUV video overlay</DT
467 HREF="sdlglattr.html"
469 > -- SDL GL Attributes</DT
474 > -- Defines a rectangular area</DT
479 > -- Format independent color description</DT
482 HREF="sdlpalette.html"
484 > -- Color palette for 8-bit pixel formats</DT
487 HREF="sdlpixelformat.html"
489 > -- Stores surface format information</DT
492 HREF="sdlsurface.html"
494 > -- Graphical Surface Structure</DT
497 HREF="sdlvideoinfo.html"
499 > -- Video Target information</DT
502 HREF="sdloverlay.html"
504 > -- YUV video overlay</DT
510 >Window Management</A
516 HREF="sdlwmsetcaption.html"
517 >SDL_WM_SetCaption</A
518 > -- Sets the window tile and icon name.</DT
521 HREF="sdlwmgetcaption.html"
522 >SDL_WM_GetCaption</A
523 > -- Gets the window title and icon name.</DT
526 HREF="sdlwmseticon.html"
528 > -- Sets the icon for the display window.</DT
531 HREF="sdlwmiconifywindow.html"
532 >SDL_WM_IconifyWindow</A
533 > -- Iconify/Minimise the window</DT
536 HREF="sdlwmtogglefullscreen.html"
537 >SDL_WM_ToggleFullScreen</A
538 > -- Toggles fullscreen mode</DT
541 HREF="sdlwmgrabinput.html"
543 > -- Grabs mouse and keyboard input.</DT
555 HREF="event.html#AEN3691"
560 HREF="eventstructures.html"
561 >SDL Event Structures.</A
565 HREF="eventfunctions.html"
579 HREF="sdlnumjoysticks.html"
581 > -- Count available joysticks.</DT
584 HREF="sdljoystickname.html"
586 > -- Get joystick name.</DT
589 HREF="sdljoystickopen.html"
591 > -- Opens a joystick for use.</DT
594 HREF="sdljoystickopened.html"
595 >SDL_JoystickOpened</A
596 > -- Determine if a joystick has been opened</DT
599 HREF="sdljoystickindex.html"
600 >SDL_JoystickIndex</A
601 > -- Get the index of an SDL_Joystick.</DT
604 HREF="sdljoysticknumaxes.html"
605 >SDL_JoystickNumAxes</A
606 > -- Get the number of joystick axes</DT
609 HREF="sdljoysticknumballs.html"
610 >SDL_JoystickNumBalls</A
611 > -- Get the number of joystick trackballs</DT
614 HREF="sdljoysticknumhats.html"
615 >SDL_JoystickNumHats</A
616 > -- Get the number of joystick hats</DT
619 HREF="sdljoysticknumbuttons.html"
620 >SDL_JoystickNumButtons</A
621 > -- Get the number of joysitck buttons</DT
624 HREF="sdljoystickupdate.html"
625 >SDL_JoystickUpdate</A
626 > -- Updates the state of all joysticks</DT
629 HREF="sdljoystickgetaxis.html"
630 >SDL_JoystickGetAxis</A
631 > -- Get the current state of an axis</DT
634 HREF="sdljoystickgethat.html"
635 >SDL_JoystickGetHat</A
636 > -- Get the current state of a joystick hat</DT
639 HREF="sdljoystickgetbutton.html"
640 >SDL_JoystickGetButton</A
641 > -- Get the current state of a given button on a given joystick</DT
644 HREF="sdljoystickgetball.html"
645 >SDL_JoystickGetBall</A
646 > -- Get relative trackball motion</DT
649 HREF="sdljoystickclose.html"
650 >SDL_JoystickClose</A
651 > -- Closes a previously opened joystick</DT
663 HREF="sdlaudiospec.html"
665 > -- Audio Specification Structure</DT
668 HREF="sdlopenaudio.html"
670 > -- Opens the audio device with the desired parameters.</DT
673 HREF="sdlpauseaudio.html"
675 > -- Pauses and unpauses the audio callback processing</DT
678 HREF="sdlgetaudiostatus.html"
679 >SDL_GetAudioStatus</A
680 > -- Get the current audio state</DT
683 HREF="sdlloadwav.html"
685 > -- Load a WAVE file</DT
688 HREF="sdlfreewav.html"
690 > -- Frees previously opened WAV data</DT
693 HREF="sdlaudiocvt.html"
695 > -- Audio Conversion Structure</DT
698 HREF="sdlbuildaudiocvt.html"
699 >SDL_BuildAudioCVT</A
700 > -- Initializes a SDL_AudioCVT structure for conversion</DT
703 HREF="sdlconvertaudio.html"
705 > -- Convert audio data to a desired audio format.</DT
708 HREF="sdlmixaudio.html"
710 > -- Mix audio data</DT
713 HREF="sdllockaudio.html"
715 > -- Lock out the callback function</DT
718 HREF="sdlunlockaudio.html"
720 > -- Unlock the callback function</DT
723 HREF="sdlcloseaudio.html"
725 > -- Shuts down audio processing and closes the audio device.</DT
737 HREF="sdlcdnumdrives.html"
739 > -- Returns the number of CD-ROM drives on the system.</DT
742 HREF="sdlcdname.html"
744 > -- Returns a human-readable, system-dependent identifier for the CD-ROM.</DT
747 HREF="sdlcdopen.html"
749 > -- Opens a CD-ROM drive for access.</DT
752 HREF="sdlcdstatus.html"
754 > -- Returns the current status of the given drive.</DT
757 HREF="sdlcdplay.html"
759 > -- Play a CD</DT
762 HREF="sdlcdplaytracks.html"
764 > -- Play the given CD track(s)</DT
767 HREF="sdlcdpause.html"
769 > -- Pauses a CDROM</DT
772 HREF="sdlcdresume.html"
774 > -- Resumes a CDROM</DT
777 HREF="sdlcdstop.html"
779 > -- Stops a CDROM</DT
782 HREF="sdlcdeject.html"
784 > -- Ejects a CDROM</DT
787 HREF="sdlcdclose.html"
789 > -- Closes a SDL_CD handle</DT
794 > -- CDROM Drive Information</DT
797 HREF="sdlcdtrack.html"
799 > -- CD Track Information Structure</DT
805 >Multi-threaded Programming</A
811 HREF="sdlcreatethread.html"
813 > -- Creates a new thread of execution that shares its parent's properties.</DT
816 HREF="sdlthreadid.html"
818 > -- Get the 32-bit thread identifier for the current thread.</DT
821 HREF="sdlgetthreadid.html"
823 > -- Get the SDL thread ID of a SDL_Thread</DT
826 HREF="sdlwaitthread.html"
828 > -- Wait for a thread to finish.</DT
831 HREF="sdlkillthread.html"
833 > -- Gracelessly terminates the thread.</DT
836 HREF="sdlcreatemutex.html"
838 > -- Create a mutex</DT
841 HREF="sdldestroymutex.html"
843 > -- Destroy a mutex</DT
846 HREF="sdlmutexp.html"
848 > -- Lock a mutex</DT
851 HREF="sdlmutexv.html"
853 > -- Unlock a mutex</DT
856 HREF="sdlcreatesemaphore.html"
857 >SDL_CreateSemaphore</A
858 > -- Creates a new semaphore and assigns an initial value to it.</DT
861 HREF="sdldestroysemaphore.html"
862 >SDL_DestroySemaphore</A
863 > -- Destroys a semaphore that was created by <A
864 HREF="sdlcreatesemaphore.html"
865 >SDL_CreateSemaphore</A
869 HREF="sdlsemwait.html"
871 > -- Lock a semaphore and suspend the thread if the semaphore value is zero.</DT
874 HREF="sdlsemtrywait.html"
876 > -- Attempt to lock a semaphore but don't suspend the thread.</DT
879 HREF="sdlsemwaittimeout.html"
880 >SDL_SemWaitTimeout</A
881 > -- Lock a semaphore, but only wait up to a specified maximum time.</DT
884 HREF="sdlsempost.html"
886 > -- Unlock a semaphore.</DT
889 HREF="sdlsemvalue.html"
891 > -- Return the current value of a semaphore.</DT
894 HREF="sdlcreatecond.html"
896 > -- Create a condition variable</DT
899 HREF="sdldestroycond.html"
901 > -- Destroy a condition variable</DT
904 HREF="sdlcondsignal.html"
906 > -- Restart a thread wait on a condition variable</DT
909 HREF="sdlcondbroadcast.html"
910 >SDL_CondBroadcast</A
911 > -- Restart all threads waiting on a condition variable</DT
914 HREF="sdlcondwait.html"
916 > -- Wait on a condition variable</DT
919 HREF="sdlcondwaittimeout.html"
920 >SDL_CondWaitTimeout</A
921 > -- Wait on a condition variable, with timeout</DT
933 HREF="sdlgetticks.html"
935 > -- Get the number of milliseconds since the SDL library initialization.</DT
940 > -- Wait a specified number of milliseconds before returning.</DT
943 HREF="sdladdtimer.html"
945 > -- Add a timer which will call a callback after the specified number of milliseconds has
949 HREF="sdlremovetimer.html"
951 > -- Remove a timer which was added with
953 HREF="sdladdtimer.html"
958 HREF="sdlsettimer.html"
960 > -- Set a callback to run after the specified number of milliseconds has
978 HREF="sdlkey.html#AEN4720"
979 >SDL Keysym definitions</A
983 HREF="sdlkey.html#SDLMOD"
984 >SDL modifier definitions</A
998 HREF="guidebasicsinit.html#AEN60"
1003 HREF="guidevideo.html#AEN71"
1004 >Initializing the Video Display</A
1008 HREF="guidevideo.html#AEN77"
1009 >Initializing the Best Video Mode</A
1013 HREF="guidevideo.html#AEN83"
1014 >Loading and Displaying a BMP File</A
1018 HREF="guidevideo.html#AEN90"
1023 HREF="guidevideo.html#AEN93"
1028 HREF="guidevideo.html#AEN97"
1029 >Using putpixel()</A
1033 HREF="guidevideoopengl.html#AEN114"
1034 >Initializing SDL with OpenGL</A
1038 HREF="guidevideoopengl.html#AEN128"
1043 HREF="guideinput.html#AEN141"
1044 >Initializing SDL with Joystick Support</A
1048 HREF="guideinput.html#AEN154"
1049 >Querying the Number of Available Joysticks</A
1053 HREF="guideinput.html#AEN183"
1054 >Opening a Joystick</A
1058 HREF="guideinput.html#AEN191"
1059 >Joystick Axis Events</A
1063 HREF="guideinput.html#AEN195"
1064 >More Joystick Axis Events</A
1068 HREF="guideinput.html#AEN203"
1069 >Joystick Button Events</A
1073 HREF="guideinput.html#AEN217"
1074 >Joystick Ball Events</A
1078 HREF="guideinput.html#AEN244"
1079 >Joystick Hat Events</A
1083 HREF="guideinput.html#AEN265"
1084 >Querying Joystick Characteristics</A
1088 HREF="guideinputkeyboard.html#AEN334"
1089 >Reading Keyboard Events</A
1093 HREF="guideinputkeyboard.html#AEN351"
1094 >Interpreting Key Event Information</A
1098 HREF="guideinputkeyboard.html#AEN363"
1099 >Proper Game Movement</A
1109 SUMMARY="Footer navigation table"