SDL-mirror/docs/man3/SDL_Palette.3

.TH "SDL_Palette" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_Palette \- Color palette for 8-bit pixel formats
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
  int ncolors;
  SDL_Color *colors;
} SDL_Palette;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBncolors\fR
Number of colors used in this palette
.TP 20
\fBcolors\fR
Pointer to \fI\fBSDL_Color\fR\fR structures that make up the palette\&.
.SH "DESCRIPTION"
.PP
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\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Color\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetColors\fP\fR \fI\fBSDL_SetPalette\fP\fR
.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01
Updated from the SDL Documentation Project --HG-- extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%40182 2001-09-14 02:41:09 +00:00			`.TH "SDL_Palette" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"`
Initial revision --HG-- extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%401 2001-04-26 16:45:43 +00:00			`.SH "NAME"`
Erik Heckers fixed bug #493 Searching the installed man pages for SDL functions fails, e.g. man -k SDL_ \|grep Video After investigating this I found that "makewhatis", the tool that generates the "whatis" database, reads the SDL_* man pages, but doesn't produce entries in the "whatis" database for the SDL_* man pages. After some more debugging I found the reason is a missing space. After editing SDL_Init.3(.gz) and replacing SDL_Init\- Initializes SDL with SDL_Init \- Initializes SDL everything works fine. After running "makewhatis" I can successfully do a man -k SDL_ and SDL_Init is listed in the output. --HG-- branch : SDL-1.2 extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%402660 2007-12-29 02:34:53 +00:00			`SDL_Palette \- Color palette for 8-bit pixel formats`
Initial revision --HG-- extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%401 2001-04-26 16:45:43 +00:00			`.SH "STRUCTURE DEFINITION"`
			`.PP`
			`.nf`
			`\f(CWtypedef struct{`
			`int ncolors;`
			`SDL_Color *colors;`
			`} SDL_Palette;\fR`
			`.fi`
			`.PP`
			`.SH "STRUCTURE DATA"`
			`.TP 20`
			`\fBncolors\fR`
			`Number of colors used in this palette`
			`.TP 20`
			`\fBcolors\fR`
			`Pointer to \fI\fBSDL_Color\fR\fR structures that make up the palette\&.`
			`.SH "DESCRIPTION"`
			`.PP`
			`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\&.`
			`.SH "SEE ALSO"`
			`.PP`
			`\fI\fBSDL_Color\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetColors\fP\fR \fI\fBSDL_SetPalette\fP\fR`
Debian patch: f230_manpages.diff --HG-- branch : SDL-1.2 extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/branches/SDL-1.2%404033 2009-10-10 10:09:01 +00:00			`.\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01`