Mercurial > sdl-ios-xcode
diff docs/html/sdlpalette.html @ 0:74212992fb08
Initial revision
author | Sam Lantinga <slouken@lokigames.com> |
---|---|
date | Thu, 26 Apr 2001 16:45:43 +0000 |
parents | |
children | 55f1f1b3e27d |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/html/sdlpalette.html Thu Apr 26 16:45:43 2001 +0000 @@ -0,0 +1,293 @@ +<HTML +><HEAD +><TITLE +>SDL_Palette</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.61 +"><LINK +REL="HOME" +TITLE="SDL Library Documentation" +HREF="index.html"><LINK +REL="UP" +TITLE="Video" +HREF="video.html"><LINK +REL="PREVIOUS" +TITLE="SDL_Color" +HREF="sdlcolor.html"><LINK +REL="NEXT" +TITLE="SDL_PixelFormat" +HREF="sdlpixelformat.html"></HEAD +><BODY +CLASS="REFENTRY" +BGCOLOR="#FFF8DC" +TEXT="#000000" +LINK="#0000ee" +VLINK="#551a8b" +ALINK="#ff0000" +><DIV +CLASS="NAVHEADER" +><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +>SDL Library Documentation</TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="sdlcolor.html" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +><A +HREF="sdlpixelformat.html" +>Next</A +></TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><H1 +><A +NAME="SDLPALETTE" +>SDL_Palette</A +></H1 +><DIV +CLASS="REFNAMEDIV" +><A +NAME="AEN2628" +></A +><H2 +>Name</H2 +>SDL_Palette -- Color palette for 8-bit pixel formats</DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN2631" +></A +><H2 +>Structure Definition</H2 +><PRE +CLASS="PROGRAMLISTING" +>typedef struct{ + int ncolors; + SDL_Color *colors; +} SDL_Palette;</PRE +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN2634" +></A +><H2 +>Structure Data</H2 +><DIV +CLASS="INFORMALTABLE" +><A +NAME="AEN2636" +></A +><P +></P +><TABLE +BORDER="0" +CLASS="CALSTABLE" +><TBODY +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="STRUCTFIELD" +><I +>ncolors</I +></TT +></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +>Number of colors used in this palette</TD +></TR +><TR +><TD +ALIGN="LEFT" +VALIGN="TOP" +><TT +CLASS="STRUCTFIELD" +><I +>colors</I +></TT +></TD +><TD +ALIGN="LEFT" +VALIGN="TOP" +>Pointer to <A +HREF="sdlcolor.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Color</SPAN +></A +> structures that make up the palette.</TD +></TR +></TBODY +></TABLE +><P +></P +></DIV +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN2649" +></A +><H2 +>Description</H2 +><P +>Each pixel in an 8-bit surface is an index into the <TT +CLASS="STRUCTFIELD" +><I +>colors</I +></TT +> field of the <SPAN +CLASS="STRUCTNAME" +>SDL_Palette</SPAN +> structure store in <A +HREF="sdlpixelformat.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_PixelFormat</SPAN +></A +>. A <SPAN +CLASS="STRUCTNAME" +>SDL_Palette</SPAN +> should never need to be created manually. It is automatically created when SDL allocates a <SPAN +CLASS="STRUCTNAME" +>SDL_PixelFormat</SPAN +> for a surface. The colors values of a <A +HREF="sdlsurface.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Surface</SPAN +></A +>s palette can be set with the <A +HREF="sdlsetcolors.html" +><TT +CLASS="FUNCTION" +>SDL_SetColors</TT +></A +>.</P +></DIV +><DIV +CLASS="REFSECT1" +><A +NAME="AEN2662" +></A +><H2 +>See Also</H2 +><P +><A +HREF="sdlcolor.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Color</SPAN +></A +>, +<A +HREF="sdlsurface.html" +><SPAN +CLASS="STRUCTNAME" +>SDL_Surface</SPAN +></A +>, +<A +HREF="sdlsetcolors.html" +><TT +CLASS="FUNCTION" +>SDL_SetColors</TT +></A +> +<A +HREF="sdlsetpalette.html" +><TT +CLASS="FUNCTION" +>SDL_SetPalette</TT +></A +></P +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="sdlcolor.html" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +><A +HREF="sdlpixelformat.html" +>Next</A +></TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>SDL_Color</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="video.html" +>Up</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +>SDL_PixelFormat</TD +></TR +></TABLE +></DIV +></BODY +></HTML +> \ No newline at end of file