table of contents
other versions
- experimental 3.1.0+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.h"
int 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 -1.
FUNCTION PARAMETERS¶
RETURN VALUE¶
Returns 0 on success or a negative error code on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.0 | SDL |