Wiki Page Content

Revision 2 as of 2009-11-22 20:53:22

Clear message

SDL_PixelFormatEnumToMasks

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

Contents

  1. SDL_PixelFormatEnumToMasks
    1. Syntax
    2. Function Parameters
    3. Return Value
    4. Code Examples
    5. Remarks
    6. Related Functions

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 red component

Gmask

a pointer to a value that will be filled in with the green component

Bmask

a pointer to a value that will be filled in with the blue component

Amask

a pointer to a value that will be filled in with the alpha component

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

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