###### (This is the legacy documentation for stable SDL2, the current stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current development version.)
# SDL_GetColorKey

Get the color key (transparent pixel) for a surface.

## Header File

Defined in [SDL_surface.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_surface.h)

## Syntax

```c
int SDL_GetColorKey(SDL_Surface * surface,
                    Uint32 * key);

```

## Function Parameters

|                 |                                                   |
| --------------- | ------------------------------------------------- |
| **surface**     | the [SDL_Surface](SDL_Surface) structure to query |
| **key**         | a pointer filled in with the transparent pixel    |

## Return Value

Returns 0 on success or a negative error code on failure; call
[SDL_GetError](SDL_GetError)() for more information.

## Remarks

The color key is a pixel of the format used by the surface, as generated by
[SDL_MapRGB](SDL_MapRGB)().

If the surface doesn't have color key enabled this function returns -1.

## Version

This function is available since SDL 2.0.0.

## See Also

* [SDL_BlitSurface](SDL_BlitSurface)
* [SDL_SetColorKey](SDL_SetColorKey)

----
[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction)