Penguin
Recent Changes
Blame: SDL_SetColorKey(3)
EditPageHistoryDiffInfoLikePages
Annotated edit history of SDL_SetColorKey(3) version 2 showing authors affecting page license. View with all changes included.
Rev Author # Line
1 perry 1 SDL_!SetColorKey
2 !!!SDL_!SetColorKey
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 RETURN VALUE
7 SEE ALSO
8 ----
9 !!NAME
10
11
12 SDL_!SetColorKey- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration.
13 !!SYNOPSIS
14
15
16 __#include __
17
18
19 __int SDL_!SetColorKey__(__SDL_Surface *surface, Uint32
20 flag, Uint32 key__);
21 !!DESCRIPTION
22
23
24 Sets the color key (transparent pixel) in a blittable
25 surface and enables or disables RLE blit
26 acceleration.
27
28
29 RLE acceleration can substantially speed up blitting of
30 images with large horizontal runs of transparent pixels
31 (i.e., pixels that match the __key__ value). The
32 __key__ must be of the same pixel format as the
33 __surface__, __SDL_MapRGB__ is often useful for
34 obtaining an acceptable value.
35
36
37 If __flag__ is __SDL_SRCCOLORKEY__ then __key__ is
38 the transparent pixel value in the source image of a
39 blit.
40
41
42 If __flag__ is OR'd with __SDL_RLEACCEL__ then the
43 surface will be draw using RLE acceleration when drawn with
44 ''SDL_!BlitSurface''. The surface will actually be encoded
45 for RLE acceleration the first time ''SDL_!BlitSurface''
46 or ''SDL_!DisplayFormat'' is called on the
47 surface.
48
49
50 If __flag__ is 0, this function clears any current color
51 key.
52 !!RETURN VALUE
53
54
55 This function returns __0__, or __-1__ if there was an
56 error.
57 !!SEE ALSO
58
59
60 __SDL_!BlitSurface__, __SDL_!DisplayFormat__,
61 __SDL_MapRGB__, __SDL_!SetAlpha__
62 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.