NAME

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

SYNOPSIS

       #include <SDL3/SDL_surface.h>

       bool SDL_SetSurfaceColorKey(SDL_Surface *surface, bool enabled, Uint32 key);

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.

RETURN VALUE

       for more information.

THREAD SAFETY

       This function is not thread safe.

AVAILABILITY

       This function is available since SDL 3.2.0.

SEE ALSO

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

Simple Directmedia Layer                           SDL 3.2.26                          SDL_SetSurfaceColorKey(3)