Mercurial > sdl-ios-xcode
view docs/man3/SDL_SetColorKey.3 @ 672:5955fa16d4b8
Date: Mon, 28 Jul 2003 18:30:50 +0300
From: "Mike Gorchak"
Subject: New test for overlays
While writting QNX Photon Overlay code I've found that the existent overlay test application is not enough, it performs too artificial tests - it always moves/resizes the overlay's viewport, but in the real life that happens very rare. So I decided to write new test (commonly base on testoverlay.c code) and called it testoverlay2 :)
moose.dat - raw 8 bit paletted data of the small movie. (It was a moose.gif, also included in the attachment as reference, but not needed for this test, it is just for information). I cannot find, who created this .gif, so no credits this time :) But over inet I saw this gif zillion times, so I think we do not infringing somebody rights :)
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Fri, 08 Aug 2003 21:31:18 +0000 |
| parents | e5bc29de3f0a |
| children | 546f7c1eb755 |
line wrap: on
line source
.TH "SDL_SetColorKey" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetColorKey\- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp \fBint \fBSDL_SetColorKey\fP\fR(\fBSDL_Surface *surface, Uint32 flag, Uint32 key\fR); .SH "DESCRIPTION" .PP Sets the color key (transparent pixel) in a blittable surface and enables or disables RLE blit acceleration\&. .PP 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\&. .PP If \fBflag\fR is \fBSDL_SRCCOLORKEY\fP then \fBkey\fR is the transparent pixel value in the source image of a blit\&. .PP 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\&. .PP If \fBflag\fR is 0, this function clears any current color key\&. .SH "RETURN VALUE" .PP This function returns \fB0\fR, or \fB-1\fR if there was an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_SetAlpha\fP\fR ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01