Commit | Line | Data |
162a0989 |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
fb9a1059 |
6 | <li><a href="#CATEGORY">CATEGORY</a></li> |
162a0989 |
7 | <li><a href="#DESCRIPTION">DESCRIPTION</a></li> |
8 | <li><a href="#METHODS">METHODS</a> |
9 | <ul><li><a href="#ncolors">ncolors ( )</a></li> |
10 | <li><a href="#colors_index">colors ( index )</a></li> |
11 | <li><a href="#color_index_index">color_index ( index )</a></li> |
162a0989 |
12 | </ul> |
13 | </li> |
14 | <li><a href="#SEE_ALSO">SEE ALSO</a> |
15 | </li> |
16 | </ul><hr /> |
17 | <!-- INDEX END --> |
18 | |
19 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
20 | <div id="NAME_CONTENT"> |
fb9a1059 |
21 | <p>SDL::Palette -- Color palette for 8-bit pixel formats </p> |
22 | |
23 | </div> |
24 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
25 | <div id="CATEGORY_CONTENT"> |
26 | <p>Core, Video, Structure</p> |
162a0989 |
27 | |
28 | </div> |
29 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
30 | <div id="DESCRIPTION_CONTENT"> |
fb9a1059 |
31 | <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> |
32 | should never need to be created manually. It is automatically created when SDL allocates a <code>SDL::PixelFormat</code> for a surface. The colors |
33 | values of a <code>SDL::Surface</code>'s palette can be set with the <code>SDL::Video::set_colors</code>.</p> |
162a0989 |
34 | |
35 | </div> |
36 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
37 | <div id="METHODS_CONTENT"> |
38 | |
39 | </div> |
40 | <h2 id="ncolors">ncolors ( )</h2> |
41 | <div id="ncolors_CONTENT"> |
42 | <p>Fetches the number of colors in palette</p> |
43 | |
44 | </div> |
45 | <h2 id="colors_index">colors ( index )</h2> |
46 | <div id="colors_index_CONTENT"> |
47 | <p>Fetches an array of colors in palette</p> |
48 | |
49 | </div> |
50 | <h2 id="color_index_index">color_index ( index )</h2> |
51 | <div id="color_index_index_CONTENT"> |
52 | <p>Fetches the SDL_Color at the provide index in palette</p> |
53 | |
54 | </div> |
162a0989 |
55 | <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p> |
56 | <div id="SEE_ALSO_CONTENT"> |
55bbf7a2 |
57 | <p><a href="SDL-Color.html">SDL::Color</a> <a href="SDL-Surface.html">SDL::Surface</a></p> |
162a0989 |
58 | |
59 | </div> |
60 | </div> |