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

SDL_HasColorKey

Returns whether the surface has a color key

Header File

Defined in SDL_surface.h

Syntax

SDL_bool SDL_HasColorKey(SDL_Surface * surface);

Function Parameters

surface the SDL_Surface structure to query

Return Value

Return SDL_TRUE if the surface has a color key, SDL_FALSE otherwise.

Remarks

It is safe to pass a NULL surface here; it will return SDL_FALSE.

Version

This function is available since SDL 2.0.9.

See Also

CategoryAPI, CategoryAPIFunction, CategorySurface