Mercurial > sdl-ios-xcode

view docs/man3/SDL_Palette.3 @ 911:04a403e4ccf5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Date: Mon, 3 May 2004 03:15:01 +0100 From: David Symmonds Subject: SDL Typedef Structs Hi, Thanks for the SDL libraries, I have been using them for about a year now and they are really brilliant. One thing that I have just found whilst using them through C++ (and needing forward declarations) is that when you typedef structs you sometimes use typedef struct Name { ... }Name; e.g. SDL_Surface and other times use typedef struct { ... }Name; e.g. SDL_Rect The first type works fine, when I define a header file I can just put 'struct Name;' at the top and use the Name throughout. However, the second type is harder to use in a header, and I haven't found a way yet, other than to include 'SDL.h' in the header file (undesirable). Would there be any harm in changing the definition of SDL_Rect and such like to the second form?
author Sam Lantinga <slouken@libsdl.org>
date Sun, 18 Jul 2004 22:57:40 +0000
parents e5bc29de3f0a
children 546f7c1eb755
line wrap: on
line source

.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