SDL_SurfaceHasColorKey(3)

SDL_SurfaceHasColorKey3

Returns whether the surface has a color key.

Usage

#include "SDL3/SDL.h"

bool SDL_SurfaceHasColorKey(SDL_Surface *surface);

Header file

Defined in SDL3/SDL_surface.h

Overview

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

Function parameters

surface

the SDL_Surface
structure to query.

Return value

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

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.