table of contents
other versions
- testing 3.2.10+ds-1
- unstable 3.2.10+ds-1
- experimental 3.3~git20250806+ds-1
SDL_GetSurfaceColorKey(3) | SDL3 FUNCTIONS | SDL_GetSurfaceColorKey(3) |
NAME¶
SDL_GetSurfaceColorKey - 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¶
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¶
SDL 3.3.0 | Simple Directmedia Layer |