(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetSurfaceColorKey

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

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

bool SDL_GetSurfaceColorKey(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

(bool) Returns true on success or false 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 false.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetSurfaceColorKey
• SDL_SurfaceHasColorKey

---

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.