# SDL_GetSurfaceColorKey

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

## Header File

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

## Syntax

```c
bool SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key);
```

## Function Parameters

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

## Return Value

(bool) Returns true on success or false 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 false.

## Thread Safety

It is safe to call this function from any thread.

## Version

This function is available since SDL 3.2.0.

## See Also

- [SDL_SetSurfaceColorKey](SDL_SetSurfaceColorKey)
- [SDL_SurfaceHasColorKey](SDL_SurfaceHasColorKey)

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

