Man page - sdl_setsurfacecolorkey(3)

Packages contas this manual

Manual

SDL_SetSurfaceColorKey(3) SDL3 FUNCTIONS SDL_SetSurfaceColorKey(3)

SDL_SetSurfaceColorKey - Set the color key (transparent pixel) in a surface.

Defined in SDL3/SDL_surface.h

#include "SDL3/SDL.h"
bool SDL_SetSurfaceColorKey(SDL_Surface *surface, bool enabled, Uint32 key);

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 ().

the SDL_Surface
structure to update.
true to enable color key, false to disable color key.
the transparent pixel.

Returns true on success or false on failure; call

SDL_GetError () for more information.

This function is not thread safe.

This function is available since SDL 3.2.0.

•(3), SDL_GetSurfaceColorKey(3), •(3), SDL_SetSurfaceRLE(3), •(3), SDL_SurfaceHasColorKey(3)

SDL 3.2.10 Simple Directmedia Layer