Mercurial > sdl-ios-xcode

comparison docs/man3/SDL_Palette.3 @ 0:74212992fb08

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
comparison
equal deleted inserted replaced
-1:000000000000 0:74212992fb08
1 .TH "SDL_Palette" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference"
2 .SH "NAME"
3 SDL_Palette\- Color palette for 8-bit pixel formats
4 .SH "STRUCTURE DEFINITION"
5 .PP
6 .nf
7 \f(CWtypedef struct{
8 int ncolors;
9 SDL_Color *colors;
10 } SDL_Palette;\fR
11 .fi
12 .PP
13 .SH "STRUCTURE DATA"
14 .TP 20
15 \fBncolors\fR
16 Number of colors used in this palette
17 .TP 20
18 \fBcolors\fR
19 Pointer to \fI\fBSDL_Color\fR\fR structures that make up the palette\&.
20 .SH "DESCRIPTION"
21 .PP
22 Each pixel in an 8-bit surface is an index into the \fBcolors\fR field of the \fBSDL_Palette\fR structure store in \fI\fBSDL_PixelFormat\fR\fR\&. A \fBSDL_Palette\fR should never need to be created manually\&. It is automatically created when SDL allocates a \fBSDL_PixelFormat\fR for a surface\&. The colors values of a \fI\fBSDL_Surface\fR\fRs palette can be set with the \fI\fBSDL_SetColors\fP\fR\&.
23 .SH "SEE ALSO"
24 .PP
25 \fI\fBSDL_Color\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetColors\fP\fR \fI\fBSDL_SetPalette\fP\fR
26 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04