Wiki Page Content

Differences between revisions 4 and 6 (spanning 2 versions)
Revision 4 as of 2009-12-12 07:09:30
Size: 1109
Editor: SheenaSmith
Comment: format update
Revision 6 as of 2010-08-22 01:23:45
Size: 1682
Editor: SheenaSmith
Comment: add 'draft' note
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
Line 26: Line 27:
A pixel value. A *32-bit* pixel value.

If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.
Line 34: Line 37:
''You can add useful comments here'' *<<BR>>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 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). <<BR>>*
Line 37: Line 42:
 .[[SDL_GetRGB]] *
 .[[SDL_GetRGBA]] *

DRAFT

SDL_MapRGBA

Use this function to map an RGBA quadruple to a pixel value for a given pixel format.

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

A *32-bit* pixel value.

If the format has a palette (8-bit) the index of the closest matching color in the palette will be returned.

Code Examples

You can add your code example here

Remarks

*
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 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).
*


CategoryAPI, CategoryPixels

None: SDL_MapRGBA (last edited 2010-09-26 17:32:32 by SheenaSmith)

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