#pragma section-numbers off
#pragma disable-camelcase

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

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
SDL_bool SDL_PixelFormatEnumToMasks(Uint32  format,
                                    int*    bpp,
                                    Uint32* Rmask,
                                    Uint32* Gmask,
                                    Uint32* Bmask,
                                    Uint32* Amask)
}}}

== Function Parameters ==
||'''format'''||one of the [[SDL_PixelFormatEnum]] values; see [[#Remarks|Remarks]] for details||
||'''bpp'''||a bits per pixel value; usually 15, 16, or 32||
||'''Rmask'''||a pointer filled in with the red mask for the format||
||'''Gmask'''||a pointer filled in with the green mask for the format||
||'''Bmask'''||a pointer filled in with the blue mask for the format||
||'''Amask'''||a pointer filled in with the alpha mask for the format||

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

== Code Examples ==
{{{#!highlight cpp
You can add your code example here
}}}

== Remarks ==
'''format''' may be one of the following:
<<Include(SDL_PixelFormatEnum, , , from="=== Pixel Format Values ===", to="== Code Examples ==")>>

== Related Functions ==
 .[[SDL_MasksToPixelFormatEnum]]

----
[[CategoryAPI]], [[CategoryPixels]]