Wiki Page Content

SDL_GetColorKey

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

Syntax

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

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().


CategoryAPI, CategorySurface

None: SDL_GetColorKey (last edited 2011-01-07 18:07:52 by SheenaSmith)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit