(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable 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

SDL_Surface *

surface

the SDL_Surface structure to query.

Return Value

(SDL_bool) 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

• SDL_SetColorKey
• SDL_GetColorKey

---

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.