aboutsummaryrefslogtreecommitdiffstats
path: root/distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3
diff options
context:
space:
mode:
authorJesse Hall <jessehall@google.com>2012-07-09 11:27:07 -0700
committerJesse Hall <jessehall@google.com>2012-07-22 00:35:08 -0700
commit9682c8870b8ff5e4ac2e4c70b759f791c6f38c1f (patch)
treeded6ee18c4e1f33df235e53615a6d65e2d64f4ef /distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3
parent74b55003f76dbca96e4a26d98fe464081ca5341f (diff)
downloadexternal_qemu-9682c8870b8ff5e4ac2e4c70b759f791c6f38c1f.zip
external_qemu-9682c8870b8ff5e4ac2e4c70b759f791c6f38c1f.tar.gz
external_qemu-9682c8870b8ff5e4ac2e4c70b759f791c6f38c1f.tar.bz2
Import SDL release-1.2.15
Change-Id: I505c4aea24325cad475f217db5589814b4c75dbf
Diffstat (limited to 'distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3')
-rw-r--r--distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.326
1 files changed, 26 insertions, 0 deletions
diff --git a/distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3 b/distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3
new file mode 100644
index 0000000..36f8893
--- /dev/null
+++ b/distrib/sdl-1.2.15/docs/man3/SDL_SetColorKey.3
@@ -0,0 +1,26 @@
+.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