---
name: "SDL_SetSurfaceColorKey"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_SetSurfaceColorKey"
---

# SDL\_SetSurfaceColorKey(3)

Set the color key (transparent pixel) in a surface.

## NAME

SDL\_SetSurfaceColorKey - Set the color key (transparent pixel) in a surface.

## HEADER FILE

Defined in SDL3/SDL\_surface.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_SetSurfaceColorKey(SDL\_Surface \*surface, bool enabled, Uint32 key);**

## DESCRIPTION

The color key defines a pixel value that will be treated as transparent in a blit. For example, one can use this to specify that cyan pixels should be considered transparent, and therefore not rendered.

It is a pixel of the format used by the surface, as generated by

**SDL\_MapRGB** ().

## FUNCTION PARAMETERS

- *surface*

  the  **SDL\_Surface**\
    structure to update.

- *enabled*

  true to enable color key, false to disable color key.

- *key*

  the transparent pixel.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

This function is not thread safe.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetSurfaceColorKey**(3)](/SDL_GetSurfaceColorKey/3.md), **•**(3), [**SDL\_SetSurfaceRLE**(3)](/SDL_SetSurfaceRLE/3.md), **•**(3), [**SDL\_SurfaceHasColorKey**(3)](/SDL_SurfaceHasColorKey/3.md)