SDL_SetSurfaceColorKey3
Set the color key (transparent pixel) in a surface.
Usage
#include "SDL3/SDL.h"
bool SDL_SetSurfaceColorKey(SDL_Surface *surface, bool enabled, Uint32 key);
Header file
Defined in SDL3/SDL_surface.h
Overview
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 |
|---|---|
enabled
|
true to enable color key, false to disable color key. |
key
|
the transparent pixel. |
Return value
Returns true on success or false on failure; call
SDL_GetError () for more information.
Thread safety
This function is not thread safe.