(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_GetColorKey

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

Header File

Defined in SDL_surface.h

Syntax

int SDL_GetColorKey(SDL_Surface * surface,
                    Uint32 * key);

Function Parameters

SDL_Surface *	surface	the SDL_Surface structure to query.
Uint32 *	key	a pointer filled in with the transparent pixel.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

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 -1.

Version

This function is available since SDL 2.0.0.

See Also

• SDL_BlitSurface
• SDL_SetColorKey

---

CategoryAPI, CategoryAPIFunction, CategorySurface

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.