NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
REL="NEXT"
TITLE="SDL Guide"
CLASS="BOOK"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
CLASS="BOOK"
NAME="AEN1"
CLASS="TOC"
HREF="guide.html"
HREF="guidepreface.html"
HREF="guidepreface.html#GUIDEABOUTSDL"
HREF="guideaboutsdldoc.html"
HREF="guidecredits.html"
HREF="guidethebasics.html"
HREF="guidethebasics.html#GUIDEINTRODUCTION"
HREF="guidebasicsinit.html"
HREF="guidevideo.html"
HREF="guidevideo.html#GUIDEVIDEOINTRO"
>Introduction to SDL Video<
/A
HREF="guidevideoopengl.html"
>Using OpenGL With SDL<
/A
HREF="guideinput.html"
HREF="guideinput.html#GUIDEINPUTJOYSTICK"
HREF="guideinputkeyboard.html"
>Handling the Keyboard<
/A
HREF="guideexamples.html"
HREF="guideexamples.html#AEN369"
HREF="guideeventexamples.html"
HREF="guideaudioexamples.html"
HREF="guidecdromexamples.html"
HREF="guidetimeexamples.html"
HREF="reference.html"
HREF="general.html"
HREF="sdlinit.html"
> &#
8212; Initializes SDL<
/DT
HREF="sdlinitsubsystem.html"
> &#
8212; Initialize subsystems<
/DT
HREF="sdlquitsubsystem.html"
> &#
8212; Shut down a subsystem<
/DT
HREF="sdlquit.html"
> &#
8212; Shut down SDL<
/DT
HREF="sdlwasinit.html"
> &#
8212; Check which subsystems are initialized<
/DT
HREF="video.html"
HREF="sdlgetvideosurface.html"
> &#
8212; returns a pointer to the current display surface<
/DT
HREF="sdlgetvideoinfo.html"
> &#
8212; returns a pointer to information about the video hardware<
/DT
HREF="sdlvideodrivername.html"
> &#
8212; Obtain the
name of the video driver<
/DT
HREF="sdllistmodes.html"
> — Returns a pointer to an array of available screen dimensions for
the given format and video flags<
/DT
HREF="sdlvideomodeok.html"
> &#
8212; Check to see if a particular video mode is supported.<
/DT
HREF="sdlsetvideomode.html"
> &#
8212; Set up a video mode with the specified
width,
height and bits-per-pixel.<
/DT
HREF="sdlupdaterect.html"
> &#
8212; Makes sure the given area is updated on the given screen.<
/DT
HREF="sdlupdaterects.html"
> &#
8212; Makes sure the given list of rectangles is updated on the given screen.<
/DT
HREF="sdlflip.html"
> &#
8212; Swaps screen buffers<
/DT
HREF="sdlsetcolors.html"
> &#
8212; Sets a portion of the colormap
for the given
8-bit surface.<
/DT
HREF="sdlsetpalette.html"
> &#
8212; Sets the colors in the palette of an
8-bit surface.<
/DT
HREF="sdlsetgamma.html"
> &#
8212; Sets the
color gamma function
for the display<
/DT
HREF="sdlgetgammaramp.html"
> &#
8212; Gets the
color gamma lookup tables
for the display<
/DT
HREF="sdlsetgammaramp.html"
> &#
8212; Sets the
color gamma lookup tables
for the display<
/DT
HREF="sdlmaprgb.html"
> &#
8212; Map a RGB
color value to a pixel format.<
/DT
HREF="sdlmaprgba.html"
> &#
8212; Map a RGBA
color value to a pixel format.<
/DT
HREF="sdlgetrgb.html"
> &#
8212; Get RGB values from a pixel in the specified pixel format.<
/DT
HREF="sdlgetrgba.html"
> &#
8212; Get RGBA values from a pixel in the specified pixel format.<
/DT
HREF="sdlcreatergbsurface.html"
> &#
8212; Create an empty SDL_Surface<
/DT
HREF="sdlcreatergbsurfacefrom.html"
>SDL_CreateRGBSurfaceFrom<
/A
> &#
8212; Create an SDL_Surface from pixel data<
/DT
HREF="sdlfreesurface.html"
> &#
8212; Frees
(deletes
) a SDL_Surface<
/DT
HREF="sdllocksurface.html"
> &#
8212; Lock a surface
for directly access.<
/DT
HREF="sdlunlocksurface.html"
> &#
8212; Unlocks a previously locked surface.<
/DT
HREF="sdlloadbmp.html"
> &#
8212; Load a Windows BMP file into an SDL_Surface.<
/DT
HREF="sdlsavebmp.html"
> &#
8212; Save an SDL_Surface as a Windows BMP file.<
/DT
HREF="sdlsetcolorkey.html"
> — Sets the color key (transparent pixel) in a blittable surface and
HREF="sdlsetalpha.html"
> &#
8212; Adjust the alpha properties of a surface<
/DT
HREF="sdlsetcliprect.html"
> &#
8212; Sets the clipping rectangle
for a surface.<
/DT
HREF="sdlgetcliprect.html"
> &#
8212; Gets the clipping rectangle
for a surface.<
/DT
HREF="sdlconvertsurface.html"
> &#
8212; Converts a surface to the same format as another surface.<
/DT
HREF="sdlblitsurface.html"
> &#
8212; This performs a fast blit from the source surface to the destination surface.<
/DT
HREF="sdlfillrect.html"
> &#
8212; This function performs a fast fill of the given rectangle with some color<
/DT
HREF="sdldisplayformat.html"
> &#
8212; Convert a surface to the display format<
/DT
HREF="sdldisplayformatalpha.html"
>SDL_DisplayFormatAlpha<
/A
> &#
8212; Convert a surface to the display format<
/DT
HREF="sdlwarpmouse.html"
> &#
8212; Set the position of the mouse cursor.<
/DT
HREF="sdlcreatecursor.html"
> &#
8212; Creates a new mouse cursor.<
/DT
HREF="sdlfreecursor.html"
> &#
8212; Frees a cursor created with SDL_CreateCursor.<
/DT
HREF="sdlsetcursor.html"
> &#
8212; Set the currently active mouse cursor.<
/DT
HREF="sdlgetcursor.html"
> &#
8212; Get the currently active mouse cursor.<
/DT
HREF="sdlshowcursor.html"
> &#
8212; Toggle whether or not the cursor is shown on the screen.<
/DT
HREF="sdlglloadlibrary.html"
> &#
8212; Specify an OpenGL library<
/DT
HREF="sdlglgetprocaddress.html"
>SDL_GL_GetProcAddress<
/A
> &#
8212; Get the address of a GL function<
/DT
HREF="sdlglgetattribute.html"
> &#
8212; Get the
value of a special SDL
/OpenGL attribute<
/DT
HREF="sdlglsetattribute.html"
> &#
8212; Set a special SDL
/OpenGL attribute<
/DT
HREF="sdlglswapbuffers.html"
> &#
8212; Swap OpenGL framebuffers
/Update Display<
/DT
HREF="sdlcreateyuvoverlay.html"
> &#
8212; Create a YUV video overlay<
/DT
HREF="sdllockyuvoverlay.html"
> &#
8212; Lock an overlay<
/DT
HREF="sdlunlockyuvoverlay.html"
> &#
8212; Unlock an overlay<
/DT
HREF="sdldisplayyuvoverlay.html"
>SDL_DisplayYUVOverlay<
/A
> &#
8212; Blit the overlay to the display<
/DT
HREF="sdlfreeyuvoverlay.html"
> &#
8212; Free a YUV video overlay<
/DT
HREF="sdlglattr.html"
> &#
8212; SDL GL Attributes<
/DT
HREF="sdlrect.html"
> &#
8212; Defines a rectangular area<
/DT
HREF="sdlcolor.html"
> &#
8212; Format independent
color description<
/DT
HREF="sdlpalette.html"
> &#
8212;
Color palette
for 8-bit pixel formats<
/DT
HREF="sdlpixelformat.html"
> &#
8212; Stores surface format information<
/DT
HREF="sdlsurface.html"
> &#
8212; Graphical Surface Structure<
/DT
HREF="sdlvideoinfo.html"
> &#
8212; Video
Target information<
/DT
HREF="sdloverlay.html"
> &#
8212; YUV video overlay<
/DT
HREF="wm.html"
HREF="sdlwmsetcaption.html"
> &#
8212; Sets the window tile and icon
name.<
/DT
HREF="sdlwmgetcaption.html"
> &#
8212; Gets the window
title and icon
name.<
/DT
HREF="sdlwmseticon.html"
> &#
8212; Sets the icon
for the display window.<
/DT
HREF="sdlwmiconifywindow.html"
> &#
8212; Iconify
/Minimise the window<
/DT
HREF="sdlwmtogglefullscreen.html"
>SDL_WM_ToggleFullScreen<
/A
> &#
8212; Toggles fullscreen mode<
/DT
HREF="sdlwmgrabinput.html"
> &#
8212; Grabs mouse and keyboard input.<
/DT
HREF="event.html"
HREF="event.html#AEN3269"
HREF="eventstructures.html"
>SDL Event Structures.<
/A
HREF="eventfunctions.html"
HREF="joystick.html"
HREF="sdlnumjoysticks.html"
> &#
8212; Count available joysticks.<
/DT
HREF="sdljoystickname.html"
> &#
8212; Get joystick
name.<
/DT
HREF="sdljoystickopen.html"
> &#
8212; Opens a joystick
for use.<
/DT
HREF="sdljoystickopened.html"
> &#
8212; Determine if a joystick has been opened<
/DT
HREF="sdljoystickindex.html"
> &#
8212; Get the index of an SDL_Joystick.<
/DT
HREF="sdljoysticknumaxes.html"
> &#
8212; Get the number of joystick axes<
/DT
HREF="sdljoysticknumballs.html"
> &#
8212; Get the number of joystick trackballs<
/DT
HREF="sdljoysticknumhats.html"
> &#
8212; Get the number of joystick hats<
/DT
HREF="sdljoysticknumbuttons.html"
>SDL_JoystickNumButtons<
/A
> &#
8212; Get the number of joysitck buttons<
/DT
HREF="sdljoystickupdate.html"
> &#
8212; Updates the state of all joysticks<
/DT
HREF="sdljoystickgetaxis.html"
> &#
8212; Get the current state of an axis<
/DT
HREF="sdljoystickgethat.html"
> &#
8212; Get the current state of a joystick hat<
/DT
HREF="sdljoystickgetbutton.html"
>SDL_JoystickGetButton<
/A
> &#
8212; Get the current state of a given button on a given joystick<
/DT
HREF="sdljoystickgetball.html"
> &#
8212; Get relative trackball motion<
/DT
HREF="sdljoystickclose.html"
> &#
8212; Closes a previously opened joystick<
/DT
HREF="audio.html"
HREF="sdlaudiospec.html"
> &#
8212; Audio Specification Structure<
/DT
HREF="sdlopenaudio.html"
> &#
8212; Opens the audio device with the desired parameters.<
/DT
HREF="sdlpauseaudio.html"
> &#
8212; Pauses and unpauses the audio callback processing<
/DT
HREF="sdlgetaudiostatus.html"
> &#
8212; Get the current audio state<
/DT
HREF="sdlloadwav.html"
> &#
8212; Load a WAVE file<
/DT
HREF="sdlfreewav.html"
> &#
8212; Frees previously opened WAV data<
/DT
HREF="sdlaudiocvt.html"
> &#
8212; Audio Conversion Structure<
/DT
HREF="sdlbuildaudiocvt.html"
> &#
8212; Initializes a SDL_AudioCVT structure
for conversion<
/DT
HREF="sdlconvertaudio.html"
> &#
8212; Convert audio
data to a desired audio format.<
/DT
HREF="sdlmixaudio.html"
> &#
8212; Mix audio data<
/DT
HREF="sdllockaudio.html"
> &#
8212; Lock out the callback function<
/DT
HREF="sdlunlockaudio.html"
> &#
8212; Unlock the callback function<
/DT
HREF="sdlcloseaudio.html"
> &#
8212; Shuts down audio processing and closes the audio device.<
/DT
HREF="cdrom.html"
HREF="sdlcdnumdrives.html"
> &#
8212; Returns the number of CD-ROM drives on the system.<
/DT
HREF="sdlcdname.html"
> &#
8212; Returns a human-readable, system-dependent identifier
for the CD-ROM.<
/DT
HREF="sdlcdopen.html"
> &#
8212; Opens a CD-ROM drive
for access.<
/DT
HREF="sdlcdstatus.html"
> &#
8212; Returns the current status of the given drive.<
/DT
HREF="sdlcdplay.html"
HREF="sdlcdplaytracks.html"
> &#
8212; Play the given CD track
(s
)<
/DT
HREF="sdlcdpause.html"
> &#
8212; Pauses a CDROM<
/DT
HREF="sdlcdresume.html"
> &#
8212; Resumes a CDROM<
/DT
HREF="sdlcdstop.html"
> &#
8212; Stops a CDROM<
/DT
HREF="sdlcdeject.html"
> &#
8212; Ejects a CDROM<
/DT
HREF="sdlcdclose.html"
> &#
8212; Closes a SDL_CD handle<
/DT
HREF="sdlcd.html"
> &#
8212; CDROM Drive Information<
/DT
HREF="sdlcdtrack.html"
> &#
8212; CD Track Information Structure<
/DT
HREF="thread.html"
>Multi-threaded Programming<
/A
HREF="sdlcreatethread.html"
> — Creates a new thread of execution that shares its parent's properties.</DT
><DT
><A
HREF="sdlthreadid.html"
>SDL_ThreadID</A
> — Get the 32-bit thread identifier for the current thread.</DT
><DT
><A
HREF="sdlgetthreadid.html"
>SDL_GetThreadID</A
> — Get the SDL thread ID of a SDL_Thread</DT
><DT
><A
HREF="sdlwaitthread.html"
>SDL_WaitThread</A
> — Wait for a thread to finish.</DT
><DT
><A
HREF="sdlkillthread.html"
>SDL_KillThread</A
> — Gracelessly terminates the thread.</DT
><DT
><A
HREF="sdlcreatemutex.html"
>SDL_CreateMutex</A
> — Create a mutex</DT
><DT
><A
HREF="sdldestroymutex.html"
>SDL_DestroyMutex</A
> — Destroy a mutex</DT
><DT
><A
HREF="sdlmutexp.html"
>SDL_mutexP</A
> — Lock a mutex</DT
><DT
><A
HREF="sdlmutexv.html"
>SDL_mutexV</A
> — Unlock a mutex</DT
><DT
><A
HREF="sdlcreatesemaphore.html"
>SDL_CreateSemaphore</A
> — Creates a new semaphore and assigns an initial value to it.</DT
><DT
><A
HREF="sdldestroysemaphore.html"
>SDL_DestroySemaphore</A
> — Destroys a semaphore that was created by <A
HREF="sdlcreatesemaphore.html"
>SDL_CreateSemaphore</A
>.</DT
><DT
><A
HREF="sdlsemwait.html"
>SDL_SemWait</A
> — Lock a semaphore and suspend the thread if the semaphore value is zero.</DT
><DT
><A
HREF="sdlsemtrywait.html"
>SDL_SemTryWait</A
> — Attempt to lock a semaphore but don't suspend the thread.<
/DT
HREF="sdlsemwaittimeout.html"
> &#
8212; Lock a semaphore, but only wait up to a specified maximum time.<
/DT
HREF="sdlsempost.html"
> &#
8212; Unlock a semaphore.<
/DT
HREF="sdlsemvalue.html"
> &#
8212; Return the current
value of a semaphore.<
/DT
HREF="sdlcreatecond.html"
> &#
8212; Create a condition variable<
/DT
HREF="sdldestroycond.html"
> &#
8212; Destroy a condition variable<
/DT
HREF="sdlcondsignal.html"
> &#
8212; Restart a thread wait on a condition variable<
/DT
HREF="sdlcondbroadcast.html"
> &#
8212; Restart all threads waiting on a condition variable<
/DT
HREF="sdlcondwait.html"
> &#
8212; Wait on a condition variable<
/DT
HREF="sdlcondwaittimeout.html"
> &#
8212; Wait on a condition variable, with timeout<
/DT
HREF="time.html"
HREF="sdlgetticks.html"
> &#
8212; Get the number of milliseconds since the SDL library initialization.<
/DT
HREF="sdldelay.html"
> &#
8212; Wait a specified number of milliseconds before returning.<
/DT
HREF="sdladdtimer.html"
> — Add a timer which will call a callback after the specified number of milliseconds has
HREF="sdlremovetimer.html"
> — Remove a timer which was added with
HREF="sdladdtimer.html"
HREF="sdlsettimer.html"
> — Set a callback to run after the specified number of milliseconds has
CLASS="LOT"
CLASS="LOT"
HREF="sdlkey.html#AEN4252"
>SDL Keysym definitions<
/A
HREF="sdlkey.html#SDLMOD"
>SDL modifier definitions<
/A
CLASS="LOT"
CLASS="LOT"
HREF="guidebasicsinit.html#AEN60"
HREF="guidevideo.html#AEN71"
>Initializing the Video Display<
/A
HREF="guidevideo.html#AEN77"
>Initializing the Best Video Mode<
/A
HREF="guidevideo.html#AEN83"
>Loading and Displaying a BMP File<
/A
HREF="guidevideo.html#AEN90"
HREF="guidevideo.html#AEN93"
HREF="guidevideo.html#AEN97"
HREF="guidevideoopengl.html#AEN114"
>Initializing SDL with OpenGL<
/A
HREF="guidevideoopengl.html#AEN128"
HREF="guideinput.html#AEN141"
>Initializing SDL with Joystick Support<
/A
HREF="guideinput.html#AEN154"
>Querying the Number of Available Joysticks<
/A
HREF="guideinput.html#AEN183"
HREF="guideinput.html#AEN191"
HREF="guideinput.html#AEN195"
>More Joystick
Axis Events<
/A
HREF="guideinput.html#AEN203"
>Joystick Button Events<
/A
HREF="guideinput.html#AEN217"
HREF="guideinput.html#AEN244"
HREF="guideinput.html#AEN265"
>Querying Joystick Characteristics<
/A
HREF="guideinputkeyboard.html#AEN334"
>Reading Keyboard Events<
/A
HREF="guideinputkeyboard.html#AEN351"
>Interpreting Key Event Information<
/A
HREF="guideinputkeyboard.html#AEN363"
CLASS="NAVFOOTER"
ALIGN="LEFT"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
WIDTH="34%"
ALIGN="center"
VALIGN="top"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
HREF="guide.html"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
WIDTH="34%"
ALIGN="center"
VALIGN="top"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>