SDL_GetSurfaceColorKey - Man Page
Get the color key (transparent pixel) for a surface.
Synopsis
#include <SDL3/SDL_surface.h> bool SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key);
Description
The color key is a pixel of the format used by the surface, as generated by SDL_MapRGB().
If the surface doesn't have color key enabled this function returns false.
Function Parameters
- surface
the SDL_Surface structure to query.
- key
a pointer filled in with the transparent pixel.
Return Value
Returns true on success or false on failure; call SDL_GetError() for more information.
Thread Safety
It is safe to call this function from any thread.
Availability
This function is available since SDL 3.2.0.
See Also
Referenced By
SDL_SetSurfaceColorKey(3), SDL_SurfaceHasColorKey(3).
SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS