(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_SurfaceHasColorKey

Returns whether the surface has a color key.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

SDL_bool SDL_SurfaceHasColorKey(SDL_Surface *surface);

Function Parameters

surface the SDL_Surface structure to query

Return Value

Returns 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 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategorySurface