SDL_SetSurfaceColorKey - Set the color key (transparent pixel) in a surface.
Contents
Availability
This function is available since SDL 3.2.0.
Description
The color key defines a pixel value that will be treated as transparent in a blit. For example, one can
use this to specify that cyan pixels should be considered transparent, and therefore not rendered.
It is a pixel of the format used by the surface, as generated by
SDL_MapRGB ().
Function Parameters
surface
the SDL_Surface
structure to update.
enabled
true to enable color key, false to disable color key.
key the transparent pixel.
Header File
Defined in SDL3/SDL_surface.h
Name
SDL_SetSurfaceColorKey - Set the color key (transparent pixel) in a surface.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetSurfaceColorKey(3), •(3), SDL_SetSurfaceRLE(3), •(3), SDL_SurfaceHasColorKey(3) Simple Directmedia Layer SDL 3.2.10 SDL_SetSurfaceColorKey(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_SetSurfaceColorKey(SDL_Surface*surface,boolenabled,Uint32key);
Thread Safety
This function is not thread safe.
