View Source: SDL_SetColorKey(3) - Waikato Linux Users Group

Edit PageHistory Diff Info LikePages

SDL_!SetColorKey
!!!SDL_!SetColorKey
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
SEE ALSO
----
!!NAME


SDL_!SetColorKey- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
!!SYNOPSIS


__#include __


__int SDL_!SetColorKey__(__SDL_Surface *surface, Uint32
flag, Uint32 key__);
!!DESCRIPTION


Sets the color key (transparent pixel) in a blittable
surface and enables or disables RLE blit
acceleration.


RLE acceleration can substantially speed up blitting of
images with large horizontal runs of transparent pixels
(i.e., pixels that match the __key__ value). The
__key__ must be of the same pixel format as the
__surface__, __SDL_MapRGB__ is often useful for
obtaining an acceptable value.


If __flag__ is __SDL_SRCCOLORKEY__ then __key__ is
the transparent pixel value in the source image of a
blit.


If __flag__ is OR'd with __SDL_RLEACCEL__ then the
surface will be draw using RLE acceleration when drawn with
''SDL_!BlitSurface''. The surface will actually be encoded
for RLE acceleration the first time ''SDL_!BlitSurface''
or ''SDL_!DisplayFormat'' is called on the
surface.


If __flag__ is 0, this function clears any current color
key.
!!RETURN VALUE


This function returns __0__, or __-1__ if there was an
error.
!!SEE ALSO


__SDL_!BlitSurface__, __SDL_!DisplayFormat__,
__SDL_MapRGB__, __SDL_!SetAlpha__
----

One page links to SDL_SetColorKey(3):

SDLManPages

This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.

Last edited on Monday, June 3, 2002 6:53:48 pm by "perry"

Edit PageHistory Diff Info LikePages