Wiki Page Content

Differences between revisions 7 and 8
Revision 7 as of 2010-09-25 00:19:03
Size: 1840
Editor: SheenaSmith
Comment: minor change
Revision 8 as of 2010-09-26 17:12:51
Size: 1679
Editor: SheenaSmith
Comment: update content (w/ Sam); remove 'draft' note
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||
Line 25: Line 24:
Returns a pixel value.

*<<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>>*
Returns a pixel value; see [[#Remarks|Remarks]] for details.
Line 42: Line 32:
''You can add useful comments here'' This function maps the RGB color value to the specified pixel format and returns the pixel value 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).

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 45: Line 41:
 .[[SDL_GetRGB]] *
 .[[SDL_GetRGBA]] *
 .[[SDL_GetRGB]]
 .[[SDL_GetRGBA]]

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; see Remarks for details.

Code Examples

You can add your code example here

Remarks

This function maps the RGB color value to the specified pixel format and returns the pixel value 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).

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_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