Wiki Page Content

Differences between revisions 8 and 9
Revision 8 as of 2009-12-13 07:15:41
Size: 1497
Editor: SheenaSmith
Comment: content added
Revision 9 as of 2010-09-25 00:35:06
Size: 1515
Editor: SheenaSmith
Comment: minor change
Deletions are marked like this. Additions are marked like this.
Line 28: Line 28:
SDL_TRUE, or SDL_FALSE if the conversion wasn't possible; call [[SDL_GetError]]() for more information. Returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't possible; call [[SDL_GetError]]() for more information.

SDL_PixelFormatEnumToMasks

Use this function to convert one of the enumerated pixel formats to a bpp value and RGBA masks.

Syntax

SDL_bool SDL_PixelFormatEnumToMasks(Uint32  format,
                                    int*    bpp,
                                    Uint32* Rmask,
                                    Uint32* Gmask,
                                    Uint32* Bmask,
                                    Uint32* Amask)              

Function Parameters

format

an enumerated pixel format; see SDL_PixelFormatEnum for details

bpp

a bits per pixel value; usually 15, 16, or 32

Rmask

a pointer to a value that will be filled in with the red mask for the pixel

Gmask

a pointer to a value that will be filled in with the green mask for the pixel

Bmask

a pointer to a value that will be filled in with the blue mask for the pixel

Amask

a pointer to a value that will be filled in with the alpha mask for the pixel

Return Value

Returns SDL_TRUE on success or SDL_FALSE if the conversion wasn't possible; call SDL_GetError() for more information.

Code Examples

You can add your code example here

Remarks

You can add useful comments here


CategoryAPI, CategoryPixels

None: SDL_PixelFormatEnumToMasks (last edited 2013-08-11 13:14:42 by PhilippWiesemann)

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