.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetSurfaceColorKey:
.\"   https://wiki.libsdl.org/SDL_GetSurfaceColorKey
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetSurfaceColorKey
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetSurfaceColorKey 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetSurfaceColorKey \- Get the color key (transparent pixel) for a surface\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_GetSurfaceColorKey(SDL_Surface *surface, Uint32 *key);
.fi
.SH DESCRIPTION
The color key is a pixel of the format used by the surface, as generated by

.BR SDL_MapRGB
()\[char46]

If the surface doesn't have color key enabled this function returns -1\[char46]

.SH FUNCTION PARAMETERS
.TP
.I surface
the 
.BR SDL_Surface
 structure to query
.TP
.I key
a pointer filled in with the transparent pixel
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_SetSurfaceColorKey (3),
.BR SDL_SurfaceHasColorKey (3)