SDL_GetSurfaceColorKey(3)

SDL_GetSurfaceColorKey3

Get the color key (transparent pixel) for a surface.

Usage

#include "SDL3/SDL.h"

bool SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key);

Header file

Defined in SDL3/SDL_surface.h

Overview

The color key is a pixel of the format used by the surface, as generated by

SDL_MapRGB ().

If the surface doesn't have color key enabled this function returns false.

Function parameters

surface

the SDL_Surface
structure to query.

key

a pointer filled in with the transparent pixel.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.