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

SDL_SurfaceHasColorKey

Returns whether the surface has a color key.

Header File

Defined in <SDL3/SDL_surface.h>

Syntax

bool SDL_SurfaceHasColorKey(SDL_Surface *surface);

Function Parameters

SDL_Surface *

surface

the SDL_Surface structure to query.

Return Value

(bool) Returns true if the surface has a color key, false otherwise.

Remarks

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetSurfaceColorKey
• SDL_GetSurfaceColorKey

---

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.