Updated SDL HTML documentation

--HG--
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%40804
This commit is contained in:
Sam Lantinga 2004-02-10 15:15:40 +00:00
parent 83ca4b6cb1
commit fbce506d5a
202 changed files with 4886 additions and 2484 deletions

View file

@ -4,7 +4,7 @@
>Video</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.64
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
@ -13,8 +13,8 @@ REL="UP"
TITLE="SDL Reference"
HREF="reference.html"><LINK
REL="PREVIOUS"
TITLE="SDL_GetError"
HREF="sdlgeterror.html"><LINK
TITLE="SDL_envvars"
HREF="sdlenvvars.html"><LINK
REL="NEXT"
TITLE="SDL_GetVideoSurface"
HREF="sdlgetvideosurface.html"><META
@ -32,6 +32,7 @@ ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
@ -48,7 +49,8 @@ WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlgeterror.html"
HREF="sdlenvvars.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
@ -62,6 +64,7 @@ ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlgetvideosurface.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
@ -74,8 +77,8 @@ CLASS="CHAPTER"
><H1
><A
NAME="VIDEO"
>Chapter 6. Video</A
></H1
></A
>Chapter 6. Video</H1
><DIV
CLASS="TOC"
><DL
@ -87,294 +90,294 @@ CLASS="TOC"
><A
HREF="sdlgetvideosurface.html"
>SDL_GetVideoSurface</A
> &#8212; returns a pointer to the current display surface</DT
>&nbsp;--&nbsp;returns a pointer to the current display surface</DT
><DT
><A
HREF="sdlgetvideoinfo.html"
>SDL_GetVideoInfo</A
> &#8212; returns a pointer to information about the video hardware</DT
>&nbsp;--&nbsp;returns a pointer to information about the video hardware</DT
><DT
><A
HREF="sdlvideodrivername.html"
>SDL_VideoDriverName</A
> &#8212; Obtain the name of the video driver</DT
>&nbsp;--&nbsp;Obtain the name of the video driver</DT
><DT
><A
HREF="sdllistmodes.html"
>SDL_ListModes</A
> &#8212; Returns a pointer to an array of available screen dimensions for
>&nbsp;--&nbsp;Returns a pointer to an array of available screen dimensions for
the given format and video flags</DT
><DT
><A
HREF="sdlvideomodeok.html"
>SDL_VideoModeOK</A
> &#8212; Check to see if a particular video mode is supported.</DT
>&nbsp;--&nbsp;Check to see if a particular video mode is supported.</DT
><DT
><A
HREF="sdlsetvideomode.html"
>SDL_SetVideoMode</A
> &#8212; Set up a video mode with the specified width, height and bits-per-pixel.</DT
>&nbsp;--&nbsp;Set up a video mode with the specified width, height and bits-per-pixel.</DT
><DT
><A
HREF="sdlupdaterect.html"
>SDL_UpdateRect</A
> &#8212; Makes sure the given area is updated on the given screen.</DT
>&nbsp;--&nbsp;Makes sure the given area is updated on the given screen.</DT
><DT
><A
HREF="sdlupdaterects.html"
>SDL_UpdateRects</A
> &#8212; Makes sure the given list of rectangles is updated on the given screen.</DT
>&nbsp;--&nbsp;Makes sure the given list of rectangles is updated on the given screen.</DT
><DT
><A
HREF="sdlflip.html"
>SDL_Flip</A
> &#8212; Swaps screen buffers</DT
>&nbsp;--&nbsp;Swaps screen buffers</DT
><DT
><A
HREF="sdlsetcolors.html"
>SDL_SetColors</A
> &#8212; Sets a portion of the colormap for the given 8-bit surface.</DT
>&nbsp;--&nbsp;Sets a portion of the colormap for the given 8-bit surface.</DT
><DT
><A
HREF="sdlsetpalette.html"
>SDL_SetPalette</A
> &#8212; Sets the colors in the palette of an 8-bit surface.</DT
>&nbsp;--&nbsp;Sets the colors in the palette of an 8-bit surface.</DT
><DT
><A
HREF="sdlsetgamma.html"
>SDL_SetGamma</A
> &#8212; Sets the color gamma function for the display</DT
>&nbsp;--&nbsp;Sets the color gamma function for the display</DT
><DT
><A
HREF="sdlgetgammaramp.html"
>SDL_GetGammaRamp</A
> &#8212; Gets the color gamma lookup tables for the display</DT
>&nbsp;--&nbsp;Gets the color gamma lookup tables for the display</DT
><DT
><A
HREF="sdlsetgammaramp.html"
>SDL_SetGammaRamp</A
> &#8212; Sets the color gamma lookup tables for the display</DT
>&nbsp;--&nbsp;Sets the color gamma lookup tables for the display</DT
><DT
><A
HREF="sdlmaprgb.html"
>SDL_MapRGB</A
> &#8212; Map a RGB color value to a pixel format.</DT
>&nbsp;--&nbsp;Map a RGB color value to a pixel format.</DT
><DT
><A
HREF="sdlmaprgba.html"
>SDL_MapRGBA</A
> &#8212; Map a RGBA color value to a pixel format.</DT
>&nbsp;--&nbsp;Map a RGBA color value to a pixel format.</DT
><DT
><A
HREF="sdlgetrgb.html"
>SDL_GetRGB</A
> &#8212; Get RGB values from a pixel in the specified pixel format.</DT
>&nbsp;--&nbsp;Get RGB values from a pixel in the specified pixel format.</DT
><DT
><A
HREF="sdlgetrgba.html"
>SDL_GetRGBA</A
> &#8212; Get RGBA values from a pixel in the specified pixel format.</DT
>&nbsp;--&nbsp;Get RGBA values from a pixel in the specified pixel format.</DT
><DT
><A
HREF="sdlcreatergbsurface.html"
>SDL_CreateRGBSurface</A
> &#8212; Create an empty SDL_Surface</DT
>&nbsp;--&nbsp;Create an empty SDL_Surface</DT
><DT
><A
HREF="sdlcreatergbsurfacefrom.html"
>SDL_CreateRGBSurfaceFrom</A
> &#8212; Create an SDL_Surface from pixel data</DT
>&nbsp;--&nbsp;Create an SDL_Surface from pixel data</DT
><DT
><A
HREF="sdlfreesurface.html"
>SDL_FreeSurface</A
> &#8212; Frees (deletes) a SDL_Surface</DT
>&nbsp;--&nbsp;Frees (deletes) a SDL_Surface</DT
><DT
><A
HREF="sdllocksurface.html"
>SDL_LockSurface</A
> &#8212; Lock a surface for directly access.</DT
>&nbsp;--&nbsp;Lock a surface for directly access.</DT
><DT
><A
HREF="sdlunlocksurface.html"
>SDL_UnlockSurface</A
> &#8212; Unlocks a previously locked surface.</DT
>&nbsp;--&nbsp;Unlocks a previously locked surface.</DT
><DT
><A
HREF="sdlloadbmp.html"
>SDL_LoadBMP</A
> &#8212; Load a Windows BMP file into an SDL_Surface.</DT
>&nbsp;--&nbsp;Load a Windows BMP file into an SDL_Surface.</DT
><DT
><A
HREF="sdlsavebmp.html"
>SDL_SaveBMP</A
> &#8212; Save an SDL_Surface as a Windows BMP file.</DT
>&nbsp;--&nbsp;Save an SDL_Surface as a Windows BMP file.</DT
><DT
><A
HREF="sdlsetcolorkey.html"
>SDL_SetColorKey</A
> &#8212; Sets the color key (transparent pixel) in a blittable surface and
>&nbsp;--&nbsp;Sets the color key (transparent pixel) in a blittable surface and
RLE acceleration.</DT
><DT
><A
HREF="sdlsetalpha.html"
>SDL_SetAlpha</A
> &#8212; Adjust the alpha properties of a surface</DT
>&nbsp;--&nbsp;Adjust the alpha properties of a surface</DT
><DT
><A
HREF="sdlsetcliprect.html"
>SDL_SetClipRect</A
> &#8212; Sets the clipping rectangle for a surface.</DT
>&nbsp;--&nbsp;Sets the clipping rectangle for a surface.</DT
><DT
><A
HREF="sdlgetcliprect.html"
>SDL_GetClipRect</A
> &#8212; Gets the clipping rectangle for a surface.</DT
>&nbsp;--&nbsp;Gets the clipping rectangle for a surface.</DT
><DT
><A
HREF="sdlconvertsurface.html"
>SDL_ConvertSurface</A
> &#8212; Converts a surface to the same format as another surface.</DT
>&nbsp;--&nbsp;Converts a surface to the same format as another surface.</DT
><DT
><A
HREF="sdlblitsurface.html"
>SDL_BlitSurface</A
> &#8212; This performs a fast blit from the source surface to the destination surface.</DT
>&nbsp;--&nbsp;This performs a fast blit from the source surface to the destination surface.</DT
><DT
><A
HREF="sdlfillrect.html"
>SDL_FillRect</A
> &#8212; This function performs a fast fill of the given rectangle with some color</DT
>&nbsp;--&nbsp;This function performs a fast fill of the given rectangle with some color</DT
><DT
><A
HREF="sdldisplayformat.html"
>SDL_DisplayFormat</A
> &#8212; Convert a surface to the display format</DT
>&nbsp;--&nbsp;Convert a surface to the display format</DT
><DT
><A
HREF="sdldisplayformatalpha.html"
>SDL_DisplayFormatAlpha</A
> &#8212; Convert a surface to the display format</DT
>&nbsp;--&nbsp;Convert a surface to the display format</DT
><DT
><A
HREF="sdlwarpmouse.html"
>SDL_WarpMouse</A
> &#8212; Set the position of the mouse cursor.</DT
>&nbsp;--&nbsp;Set the position of the mouse cursor.</DT
><DT
><A
HREF="sdlcreatecursor.html"
>SDL_CreateCursor</A
> &#8212; Creates a new mouse cursor.</DT
>&nbsp;--&nbsp;Creates a new mouse cursor.</DT
><DT
><A
HREF="sdlfreecursor.html"
>SDL_FreeCursor</A
> &#8212; Frees a cursor created with SDL_CreateCursor.</DT
>&nbsp;--&nbsp;Frees a cursor created with SDL_CreateCursor.</DT
><DT
><A
HREF="sdlsetcursor.html"
>SDL_SetCursor</A
> &#8212; Set the currently active mouse cursor.</DT
>&nbsp;--&nbsp;Set the currently active mouse cursor.</DT
><DT
><A
HREF="sdlgetcursor.html"
>SDL_GetCursor</A
> &#8212; Get the currently active mouse cursor.</DT
>&nbsp;--&nbsp;Get the currently active mouse cursor.</DT
><DT
><A
HREF="sdlshowcursor.html"
>SDL_ShowCursor</A
> &#8212; Toggle whether or not the cursor is shown on the screen.</DT
>&nbsp;--&nbsp;Toggle whether or not the cursor is shown on the screen.</DT
><DT
><A
HREF="sdlglloadlibrary.html"
>SDL_GL_LoadLibrary</A
> &#8212; Specify an OpenGL library</DT
>&nbsp;--&nbsp;Specify an OpenGL library</DT
><DT
><A
HREF="sdlglgetprocaddress.html"
>SDL_GL_GetProcAddress</A
> &#8212; Get the address of a GL function</DT
>&nbsp;--&nbsp;Get the address of a GL function</DT
><DT
><A
HREF="sdlglgetattribute.html"
>SDL_GL_GetAttribute</A
> &#8212; Get the value of a special SDL/OpenGL attribute</DT
>&nbsp;--&nbsp;Get the value of a special SDL/OpenGL attribute</DT
><DT
><A
HREF="sdlglsetattribute.html"
>SDL_GL_SetAttribute</A
> &#8212; Set a special SDL/OpenGL attribute</DT
>&nbsp;--&nbsp;Set a special SDL/OpenGL attribute</DT
><DT
><A
HREF="sdlglswapbuffers.html"
>SDL_GL_SwapBuffers</A
> &#8212; Swap OpenGL framebuffers/Update Display</DT
>&nbsp;--&nbsp;Swap OpenGL framebuffers/Update Display</DT
><DT
><A
HREF="sdlcreateyuvoverlay.html"
>SDL_CreateYUVOverlay</A
> &#8212; Create a YUV video overlay</DT
>&nbsp;--&nbsp;Create a YUV video overlay</DT
><DT
><A
HREF="sdllockyuvoverlay.html"
>SDL_LockYUVOverlay</A
> &#8212; Lock an overlay</DT
>&nbsp;--&nbsp;Lock an overlay</DT
><DT
><A
HREF="sdlunlockyuvoverlay.html"
>SDL_UnlockYUVOverlay</A
> &#8212; Unlock an overlay</DT
>&nbsp;--&nbsp;Unlock an overlay</DT
><DT
><A
HREF="sdldisplayyuvoverlay.html"
>SDL_DisplayYUVOverlay</A
> &#8212; Blit the overlay to the display</DT
>&nbsp;--&nbsp;Blit the overlay to the display</DT
><DT
><A
HREF="sdlfreeyuvoverlay.html"
>SDL_FreeYUVOverlay</A
> &#8212; Free a YUV video overlay</DT
>&nbsp;--&nbsp;Free a YUV video overlay</DT
><DT
><A
HREF="sdlglattr.html"
>SDL_GLattr</A
> &#8212; SDL GL Attributes</DT
>&nbsp;--&nbsp;SDL GL Attributes</DT
><DT
><A
HREF="sdlrect.html"
>SDL_Rect</A
> &#8212; Defines a rectangular area</DT
>&nbsp;--&nbsp;Defines a rectangular area</DT
><DT
><A
HREF="sdlcolor.html"
>SDL_Color</A
> &#8212; Format independent color description</DT
>&nbsp;--&nbsp;Format independent color description</DT
><DT
><A
HREF="sdlpalette.html"
>SDL_Palette</A
> &#8212; Color palette for 8-bit pixel formats</DT
>&nbsp;--&nbsp;Color palette for 8-bit pixel formats</DT
><DT
><A
HREF="sdlpixelformat.html"
>SDL_PixelFormat</A
> &#8212; Stores surface format information</DT
>&nbsp;--&nbsp;Stores surface format information</DT
><DT
><A
HREF="sdlsurface.html"
>SDL_Surface</A
> &#8212; Graphical Surface Structure</DT
>&nbsp;--&nbsp;Graphical Surface Structure</DT
><DT
><A
HREF="sdlvideoinfo.html"
>SDL_VideoInfo</A
> &#8212; Video Target information</DT
>&nbsp;--&nbsp;Video Target information</DT
><DT
><A
HREF="sdloverlay.html"
>SDL_Overlay</A
> &#8212; YUV video overlay</DT
>&nbsp;--&nbsp;YUV video overlay</DT
></DL
></DIV
><P
@ -442,6 +445,7 @@ CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
@ -452,7 +456,8 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlgeterror.html"
HREF="sdlenvvars.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
@ -461,6 +466,7 @@ ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
@ -469,6 +475,7 @@ ALIGN="right"
VALIGN="top"
><A
HREF="sdlgetvideosurface.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
@ -477,13 +484,14 @@ HREF="sdlgetvideosurface.html"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_GetError</TD
>SDL_envvars</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="reference.html"
ACCESSKEY="U"
>Up</A
></TD
><TD