Merge branch 'master' of git.shadowcat.co.uk:SDL-Site

[sdlgit/SDL-Site.git] / pages / SDL-Palette.html-inc

<div class="pod">
<!-- INDEX START -->
<h3 id="TOP">Index</h3>

<ul><li><a href="#NAME">NAME</a></li>
<li><a href="#CATEGORY">CATEGORY</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#METHODS">METHODS</a>
<ul><li><a href="#ncolors">ncolors ( )</a></li>
<li><a href="#colors_index">colors ( index )</a></li>
<li><a href="#color_index_index">color_index ( index )</a></li>
</ul>
</li>
<li><a href="#SEE_ALSO">SEE ALSO</a></li>
<li><a href="#AUTHORS">AUTHORS</a>
</li>
</ul><hr />
<!-- INDEX END -->

<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="NAME_CONTENT">
<p>SDL::Palette -- Color palette for 8-bit pixel formats </p>

</div>
<h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="CATEGORY_CONTENT">
<p>Core, Video, Structure</p>

</div>
<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="DESCRIPTION_CONTENT">
<p>Each pixel in an 8-bit surface is an index into the colors field of the <code>SDL::Palette</code> structure store in <code>SDL::PixelFormat</code>. A <code>SDL::Palette</code>
should never need to be created manually. It is automatically created when SDL allocates a <code>SDL::PixelFormat</code> for a surface. The colors 
values of a <code>SDL::Surface</code>'s palette can be set with the <code>SDL::Video::set_colors</code>.</p>

</div>
<h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="METHODS_CONTENT">

</div>
<h2 id="ncolors">ncolors ( )</h2>
<div id="ncolors_CONTENT">
<p>Fetches the number of colors in palette</p>

</div>
<h2 id="colors_index">colors ( index )</h2>
<div id="colors_index_CONTENT">
<p>Fetches an array of colors in palette</p>

</div>
<h2 id="color_index_index">color_index ( index )</h2>
<div id="color_index_index_CONTENT">
<p>Fetches the SDL_Color at the provide index in palette</p>

</div>
<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="SEE_ALSO_CONTENT">
<p><a href="SDL-Color.html">SDL::Color</a> <a href="SDL-Surface.html">SDL::Surface</a></p>

</div>
<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
<div id="AUTHORS_CONTENT">
<p>See <a href="/SDL.html#AUTHORS">/SDL.html#AUTHORS</a>.</p>

</div>
</div>