docs/man3/SDL_SetColorKey.3
changeset 3352 6dc250ebdd80
parent 3351 8e0182c236d8
child 3353 6b14223dd5c7
     1.1 --- a/docs/man3/SDL_SetColorKey.3	Wed Oct 07 06:11:53 2009 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,26 +0,0 @@
     1.4 -.TH "SDL_SetColorKey" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" 
     1.5 -.SH "NAME"
     1.6 -SDL_SetColorKey \- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration\&.
     1.7 -.SH "SYNOPSIS"
     1.8 -.PP
     1.9 -\fB#include "SDL\&.h"
    1.10 -.sp
    1.11 -\fBint \fBSDL_SetColorKey\fP\fR(\fBSDL_Surface *surface, Uint32 flag, Uint32 key\fR);
    1.12 -.SH "DESCRIPTION"
    1.13 -.PP
    1.14 - Sets the color key (transparent pixel) in a blittable surface and enables or disables RLE blit acceleration\&.
    1.15 -.PP
    1.16 -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\&.
    1.17 -.PP
    1.18 -If \fBflag\fR is \fBSDL_SRCCOLORKEY\fP then \fBkey\fR is the transparent pixel value in the source image of a blit\&.
    1.19 -.PP
    1.20 -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\&.
    1.21 -.PP
    1.22 -If \fBflag\fR is 0, this function clears any current color key\&.
    1.23 -.SH "RETURN VALUE"
    1.24 -.PP
    1.25 -This function returns \fB0\fR, or \fB-1\fR if there was an error\&.
    1.26 -.SH "SEE ALSO"
    1.27 -.PP
    1.28 -\fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_SetAlpha\fP\fR
    1.29 -...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01