Mercurial > sdl-ios-xcode
annotate docs/man3/SDL_SetColorKey.3 @ 4184:ed5913896653 SDL-1.2
Disable Sound Manager support on Mac OS X.
It's an OS 9 API that was exposed via Carbon, but is gone in the 10.6 SDK.
OS X uses CoreAudio. We only had it in here for debugging purposes anyhow,
as SDL would never use it unless forced to with an environment variable.
It remains in SDL for OS 9, of course.
| author | Ryan C. Gordon <icculus@icculus.org> |
|---|---|
| date | Sat, 12 Sep 2009 12:50:25 +0000 |
| parents | 4e3b250c950e |
| children | 1238da4a7112 |
| rev | line source |
|---|---|
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
1 .TH "SDL_SetColorKey" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" |
| 0 | 2 .SH "NAME" |
|
4107
4e3b250c950e
Erik Heckers fixed bug #493
Sam Lantinga <slouken@libsdl.org>
parents:
181
diff
changeset
|
3 SDL_SetColorKey \- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration\&. |
| 0 | 4 .SH "SYNOPSIS" |
| 5 .PP | |
| 6 \fB#include "SDL\&.h" | |
| 7 .sp | |
| 8 \fBint \fBSDL_SetColorKey\fP\fR(\fBSDL_Surface *surface, Uint32 flag, Uint32 key\fR); | |
| 9 .SH "DESCRIPTION" | |
| 10 .PP | |
| 11 Sets the color key (transparent pixel) in a blittable surface and enables or disables RLE blit acceleration\&. | |
| 12 .PP | |
| 13 RLE acceleration can substantially speed up blitting of images with large horizontal runs of transparent pixels (i\&.e\&., pixels that match the \fBkey\fR value)\&. The \fBkey\fR must be of the same pixel format as the \fBsurface\fR, \fI\fBSDL_MapRGB\fP\fR is often useful for obtaining an acceptable value\&. | |
| 14 .PP | |
| 15 If \fBflag\fR is \fBSDL_SRCCOLORKEY\fP then \fBkey\fR is the transparent pixel value in the source image of a blit\&. | |
| 16 .PP | |
| 17 If \fBflag\fR is OR\&'d with \fBSDL_RLEACCEL\fP then the surface will be draw using RLE acceleration when drawn with \fISDL_BlitSurface\fR\&. The surface will actually be encoded for RLE acceleration the first time \fISDL_BlitSurface\fR or \fISDL_DisplayFormat\fR is called on the surface\&. | |
| 18 .PP | |
| 19 If \fBflag\fR is 0, this function clears any current color key\&. | |
| 20 .SH "RETURN VALUE" | |
| 21 .PP | |
| 22 This function returns \fB0\fR, or \fB-1\fR if there was an error\&. | |
| 23 .SH "SEE ALSO" | |
| 24 .PP | |
| 25 \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_SetAlpha\fP\fR | |
|
181
e5bc29de3f0a
Updated from the SDL Documentation Project
Sam Lantinga <slouken@libsdl.org>
parents:
55
diff
changeset
|
26 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 |