#pragma section-numbers off
#pragma disable-camelcase

= SDL_GetColorKey =
Use this function to get the color key (transparent pixel) for a surface.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
int SDL_GetColorKey(SDL_Surface* surface,
                    Uint32*      key)
}}}

== Function Parameters ==
||'''surface'''||the [[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]]() for more information.

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


== Code Examples ==
{{{#!highlight cpp
You can add your code example here
}}}

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

== Related Functions ==
 .[[SDL_BlitSurface]]
 .[[SDL_SetColorKey]]

----
[[CategoryAPI]], [[CategorySurface]]