comparison docs/man3/SDL_SetPalette.3 @ 55:55f1f1b3e27d

Added new docs for SDL 1.2.1
author Sam Lantinga <slouken@lokigames.com>
date Sun, 10 Jun 2001 19:31:57 +0000
parents 74212992fb08
children e5bc29de3f0a
comparison
equal deleted inserted replaced
54:028447a8a758 55:55f1f1b3e27d
1 .TH "SDL_SetPalette" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" 1 .TH "SDL_SetPalette" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
2 .SH "NAME" 2 .SH "NAME"
3 SDL_SetPalette\- Sets the colors in the palette of an 8-bit surface\&. 3 SDL_SetPalette\- Sets the colors in the palette of an 8-bit surface\&.
4 .SH "SYNOPSIS" 4 .SH "SYNOPSIS"
5 .PP 5 .PP
6 \fB#include "SDL\&.h" 6 \fB#include "SDL\&.h"
7 .sp 7 .sp
8 \fBint \fBSDL_SetPalette\fP\fR(\fBSDL_Surface *surface, int flags, int SDL_Color *colors, int firstcolor, int ncolors\fR); 8 \fBint \fBSDL_SetPalette\fP\fR(\fBSDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors\fR);
9 .SH "DESCRIPTION" 9 .SH "DESCRIPTION"
10 .PP 10 .PP
11 Sets a portion of the palette for the given 8-bit surface\&. 11 Sets a portion of the palette for the given 8-bit surface\&.
12 .PP 12 .PP
13 Palettized (8-bit) screen surfaces with the \fBSDL_HWPALETTE\fP flag have two palettes, a logical palette that is used for mapping blits to/from the surface and a physical palette (that determines how the hardware will map the colors to the display)\&. \fISDL_BlitSurface\fR always uses the logical palette when blitting surfaces (if it has to convert between surface pixel formats)\&. Because of this, it is often useful to modify only one or the other palette to achieve various special color effects (e\&.g\&., screen fading, color flashes, screen dimming)\&. 13 Palettized (8-bit) screen surfaces with the \fBSDL_HWPALETTE\fP flag have two palettes, a logical palette that is used for mapping blits to/from the surface and a physical palette (that determines how the hardware will map the colors to the display)\&. \fISDL_BlitSurface\fR always uses the logical palette when blitting surfaces (if it has to convert between surface pixel formats)\&. Because of this, it is often useful to modify only one or the other palette to achieve various special color effects (e\&.g\&., screen fading, color flashes, screen dimming)\&.
54 .fi 54 .fi
55 .PP 55 .PP
56 .SH "SEE ALSO" 56 .SH "SEE ALSO"
57 .PP 57 .PP
58 \fISDL_SetColors\fR, \fISDL_SetVideoMode\fR, \fISDL_Surface\fR, \fISDL_Color\fR 58 \fISDL_SetColors\fR, \fISDL_SetVideoMode\fR, \fISDL_Surface\fR, \fISDL_Color\fR
59 ...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 59 ...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42