Man page - sdl_setsurfacecolorkey(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_SetSurfaceColorKey

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

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

HEADER FILE

Defined in SDL3/SDL_surface.h

SYNOPSIS

#include "SDL3/SDL.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

Returns true on success or false on failure; call

SDL_GetError () for more information.

THREAD SAFETY

This function is not thread safe.

AVAILABILITY

This function is available since SDL 3.2.0.