Wiki Page Content

Differences between revisions 2 and 3
Revision 2 as of 2010-02-25 20:38:54
Size: 932
Editor: SheenaSmith
Comment: question added
Revision 3 as of 2010-09-23 20:14:24
Size: 1114
Editor: SheenaSmith
Comment: update content - standard return value
Deletions are marked like this. Additions are marked like this.
Line 21: Line 21:
Returns 0 on success, or -1 if the surface is not valid or colorkey is not enabled; call [[SDL_GetError]]() for more information. Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information.

If the surface is not valid or colorkey is not enabled it returns -1. <<Color2(green,Where is "colorkey" from? Is that in a struct or is it related to the '''key''' param? Should it be in monospace?)>>

DRAFT

SDL_GetColorKey

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

Syntax

int SDL_GetColorKey(SDL_Surface* surface,
                    Uint32*      key)

Function Parameters

surface

the surface to update query?

key

a pointer filled in with the transparent pixel in the native surface format

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

If the surface is not valid or colorkey is not enabled it returns -1. green

Code Examples

You can add your code example here

Remarks

You can add useful comments here


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