SDL_MapRGB

Map an RGB triple to an opaque pixel value for a given pixel format.

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

extern (C) nothrow @nogc extern
SDL_MapRGB

Parameters

format const(SDL_PixelFormatDetails)*

a pointer to SDL_PixelFormatDetails describing the pixel format.

palette const(SDL_Palette)*

an optional palette for indexed formats, may be NULL.

r Uint8

the red component of the pixel in the range 0-255.

g Uint8

the green component of the pixel in the range 0-255.

b Uint8

the blue component of the pixel in the range 0-255.

Return Value

Type: Uint32

a pixel value.

Threadsafety: It is safe to call this function from any thread, as long as the palette is not modified.

See Also

Meta