Wiki Page Content

Differences between revisions 1 and 7 (spanning 6 versions)
Revision 1 as of 2009-11-18 20:48:06
Size: 717
Editor: SheenaSmith
Comment: create page, add content
Revision 7 as of 2010-09-25 00:19:03
Size: 1840
Editor: SheenaSmith
Comment: minor change
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
Line 18: Line 19:
||'''format'''||||
||'''r'''||||
||'''g'''||||
||'''b'''||||
||'''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||
Line 24: Line 25:
Returns a pixel value.
Line 25: Line 27:
*<<BR>>^This function^ Maps the RGB color value to the specified pixel format and returns the pixel value as a 32-bit int best approximating the given RGB color value for the given pixel format.

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

If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

<<Color2(green,Does this next part belong in Remarks instead?)>>
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 32: Line 42:
You can add useful comments here ''You can add useful comments here''
Line 35: Line 45:
 .[[SDL_GetRGB]] *
 .[[SDL_GetRGBA]] *
Line 36: Line 48:

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

DRAFT

SDL_MapRGB

Use this function to map an RGB triple to an opaque pixel value for a given pixel format.

Syntax

Uint32 SDL_MapRGB(const SDL_PixelFormat* format,
                  Uint8                  r, 
                  Uint8                  g, 
                  Uint8                  b)

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

Return Value

Returns a pixel value.

*
This function Maps the RGB color value to the specified pixel format and returns the pixel value as a 32-bit int best approximating the given RGB color value for the given pixel format.

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

If the specified pixel format has an alpha component it will be returned as all 1 bits (fully opaque).

green

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

Code Examples

You can add your code example here

Remarks

You can add useful comments here


CategoryAPI, CategoryPixels

None: SDL_MapRGB (last edited 2010-09-26 17:12:51 by SheenaSmith)

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