|
⇤ ← Revision 1 as of 2009-11-18 22:24:10
Size: 979
Comment: create page, add content
|
Size: 1371
Comment: content added
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 5: | Line 5: |
| Use this function to convert one of the enumerated pixel formats to a bpp and RGBA masks. | Use this function to convert one of the enumerated pixel formats to a bpp value and RGBA masks. |
| Line 20: | Line 20: |
| ||'''format'''|||| ||'''bpp'''|||| ||'''Rmask'''|||| ||'''Gmask'''|||| ||'''Bmask'''|||| ||'''Amask'''|||| |
||'''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|| |
| Line 28: | Line 28: |
| SDL_TRUE, or SDL_FALSE if the conversion wasn't possible. | SDL_TRUE, 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.
Contents
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
