<html> <head><title>ClanLib Reference: CL_Palette</title></head> <body text=black link=blue vlink=#800080 bgcolor=white topmargin=0 leftmargin=0> <table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td><img border=0 src="../images/eyeheader-main-purple-a.gif" alt="ClanSoft logo" width=525 height=96></td></tr> <tr bgcolor=#dadada><td align=left valign=top><img border=0 src="../images/eyeheader-main-purple-b.gif" alt="ClanSoft logo" width=190 height=14></td><td align=right valign=top><img border=0 src="../images/clanlib_light.gif" width=42 height=14></td></tr></table> <table align=center border=0 cellspacing=10> <tr> <td><a href="entire_class_index.html">Entire Class Index</a></td> <td><a href="class_index.html">Main Class Index</a></td> <td><a href="cross_index.html">Cross Index</a></td> <td><a href="global_index.html">Global Index</a></td> </table><h1 align=center>Class CL_Palette</h1><p> <b> Palette class.</b><br> Contained in: <a href="global_index.html">global</a><br> Derived from: <i>none</i> <br> Derived by: <i>none</i> <br>Group: Display (Display 2D) <p> #include <ClanLib/display.h> <p> <hr noshade> <table border=0> <tr><td colspan=3><h3>public function member index:</h3></td> <tr valign=top><td align=left><h3>Construction:</h3></td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Palette.html#1316"><tt><font color=blue><b>CL_Palette</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt><tt>virtual</tt> </tt> </td><td align=right><a href="CL_Palette.html#1317"><tt><font color=blue><b>~CL_Palette</b></font></tt></a></td><td><tt>()</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Palette.html#1318"><tt><font color=blue><b>CL_Palette</b></font></tt></a></td><td><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>* <tt><font color=blue>palette</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>num_colors</font></tt>=256)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Palette.html#1319"><tt><font color=blue><b>CL_Palette</b></font></tt></a></td><td><tt>(<tt><font color=purple>char</font></tt>* <tt><font color=blue>palette_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>)</tt>;</td> <tr valign=top><td align=right><tt></tt> </td><td align=right><a href="CL_Palette.html#1320"><tt><font color=blue><b>CL_Palette</b></font></tt></a></td><td><tt>(<a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>* <tt><font color=blue>input</font></tt>)</tt>;</td> <tr><td> </td></table> <hr noshade> <h2>Description:</h2> <a href="CL_Palette.html">CL_Palette</a> represents a palette in the form of a 256 byte array.<br><br> Palettes are in ClanLib only used by surface providers. A provider specifies it's palette by returning a <a href="CL_Palette.html">CL_Palette</a>. But It can also choose to return NULL. In that case it will use the system palette. You can change the system palette from <a href="CL_Display.html">CL_Display</a> or <a href="CL_DisplayCard.html">CL_DisplayCard</a>.<br> See Also - <a href="CL_Display.html">CL_Display</a> - The system palette is set here.<br> See Also - <a href="CL_DisplayCard.html">CL_DisplayCard</a> - The card specific system palette is set here.<br> See Also - <a href="CL_SurfaceProvider.html">CL_SurfaceProvider</a> - Palettelized surfaces use this class.<br><p> <hr noshade> <h2>Function Member Descriptions:</h2> <a name="1316"><font size=+1><b>CL_Palette::CL_Palette</b></font></a> - Creates a palette.<br><tt></tt> <a href="CL_Palette.html#1316"><tt><font color=blue><b>CL_Palette</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1318"><font size=+1><b>CL_Palette::CL_Palette</b></font></a> - Creates a palette using values from an unsigned char array.<br><tt></tt> <a href="CL_Palette.html#1318"><tt><font color=blue><b>CL_Palette</b></font></tt></a><tt>(<tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt>* <tt><font color=blue>palette</font></tt>, <tt><font color=purple>int</font></tt> <tt><font color=blue>num_colors</font></tt>=256)</tt>;<br><blockquote> palette - palette source.<br> num_colors - number of palette colors.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1319"><font size=+1><b>CL_Palette::CL_Palette</b></font></a> - Creates a palette from a input source.<br><tt></tt> <a href="CL_Palette.html#1319"><tt><font color=blue><b>CL_Palette</b></font></tt></a><tt>(<tt><font color=purple>char</font></tt>* <tt><font color=blue>palette_id</font></tt>, <a href="CL_InputSourceProvider.html"><tt><font color=navy><b>CL_InputSourceProvider</b></font></tt></a>* <tt><font color=blue>provider</font></tt>)</tt>;<br><blockquote> palette_id - ID used to get palette from provider.<br> provider - Input source type (eg. a datafile or a normal file).</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1320"><font size=+1><b>CL_Palette::CL_Palette</b></font></a> - Creates a palette from an already open input source.<br><tt></tt> <a href="CL_Palette.html#1320"><tt><font color=blue><b>CL_Palette</b></font></tt></a><tt>(<a href="CL_InputSource.html"><tt><font color=navy><b>CL_InputSource</b></font></tt></a>* <tt><font color=blue>input</font></tt>)</tt>;<br><blockquote> input - Input source to read from.</blockquote> <hr size="1" width="70%" align="left" noshade="noshade"><br><br> <a name="1317"><font size=+1><b>CL_Palette::~CL_Palette</b></font></a> - Palette destructor<br><tt><tt>virtual</tt> </tt> <a href="CL_Palette.html#1317"><tt><font color=blue><b>~CL_Palette</b></font></tt></a><tt>()</tt>;<hr size="1" width="70%" align="left" noshade="noshade"><br><br> <hr noshade> <h2>Variable Member Descriptions:</h2> <a name="1315"><font size=+1><b>CL_Palette::num_colors</b></font></a> - Number of colours in the palette.<br> <tt><tt><font color=purple>int</font></tt> </tt> <tt><a href="CL_Palette.html#1315"><tt><font color=blue>num_colors</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <a name="1314"><font size=+1><b>CL_Palette::palette</b></font></a> - The actual palette. 1 byte for each color component (rgb), 256 colors.<br> <tt><tt><font color=navy>unsigned</font></tt> <tt><font color=purple>char</font></tt> *</tt> <tt><a href="CL_Palette.html#1314"><tt><font color=blue>palette</font></tt></a>;</tt><hr size="1" width="70%" align="left" noshade="noshade"><br> <hr noshade> </body> </html>
