|
Size: 778
Comment: create page, add content
|
← Revision 10 as of 2010-09-26 17:32:32 ⇥
Size: 1819
Comment: update content (w/ Sam); remove 'draft' note
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 19: | Line 19: |
| ||'''format'''|||| ||'''r'''|||| ||'''g'''|||| ||'''b'''|||| ||'''a'''|||| |
||'''format'''||an [[SDL_PixelFormat]] structure describing the format of the pixel|| ||'''r'''||the red component of the pixel in the range 0-255|| ||'''g'''||the green component of the pixel in the range 0-255|| ||'''b'''||the blue component of the pixel in the range 0-255|| ||'''a'''||the alpha component of the pixel in the range 0-255|| |
| Line 26: | Line 26: |
| Returns a pixel value; see [[#Remarks|Remarks]] for details. | |
| Line 34: | Line 34: |
| You can add useful comments here | This function maps the RGBA color value to the specified pixel format and returns the pixel value best approximating the given RGBA color value for the given pixel format. If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette). If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned. If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format). |
| Line 37: | Line 43: |
| .[[SDL_GetRGB]] .[[SDL_GetRGBA]] |
|
| Line 38: | Line 46: |
---- [[CategoryAPI]], [[CategoryPixels]] |
SDL_MapRGBA
Use this function to map an RGBA quadruple to a pixel value for a given pixel format.
Contents
Syntax
Uint32 SDL_MapRGBA(const SDL_PixelFormat* format,
Uint8 r,
Uint8 g,
Uint8 b,
Uint8 a)
Function Parameters
format |
an SDL_PixelFormat structure describing the format of the pixel |
r |
the red component of the pixel in the range 0-255 |
g |
the green component of the pixel in the range 0-255 |
b |
the blue component of the pixel in the range 0-255 |
a |
the alpha component of the pixel in the range 0-255 |
Return Value
Returns a pixel value; see Remarks for details.
Code Examples
You can add your code example here
Remarks
This function maps the RGBA color value to the specified pixel format and returns the pixel value best approximating the given RGBA color value for the given pixel format.
If the specified pixel format has no alpha component the alpha value will be ignored (as it will be in formats with a palette).
If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
If the pixel format bpp (color depth) is less than 32-bpp then the unused upper bits of the return value can safely be ignored (e.g., with a 16-bpp format the return value can be assigned to a Uint16, and similarly a Uint8 for an 8-bpp format).
