Wiki Page Content

Differences between revisions 3 and 4
Revision 3 as of 2009-11-22 20:54:59
Size: 1351
Editor: SheenaSmith
Comment: content corrections
Revision 4 as of 2009-11-22 20:59:06
Size: 1475
Editor: SheenaSmith
Comment: content changed
Deletions are marked like this. Additions are marked like this.
Line 22: Line 22:
||'''Rmask'''||a pointer to a value that will be filled in with the red mask||
||'''Gmask'''||a pointer to a value that will be filled in with the green mask||
||'''Bmask'''||a pointer to a value that will be filled in with the blue mask||
||'''Amask'''||a pointer to a value that will be filled in with the alpha mask||
||'''Rmask'''||a pointer to a value that will be filled in with the mask for the red component of the pixel||
||'''Gmask'''||a pointer to a value that will be filled in with the mask for the green component of the pixel||
||'''Bmask'''||a pointer to a value that will be filled in with the mask for the blue component of the pixel||
||'''Amask'''||a pointer to a value that will be filled in with the mask for the alpha component of the pixel||

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

bpp

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

Rmask

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

Gmask

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

Bmask

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

Amask

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

Return Value

SDL_TRUE, 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

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