SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_MapRGB

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

Header File

Defined in SDL_pixels.h

Syntax

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

Function Parameters

const SDL_PixelFormat * format an SDL_PixelFormat structure describing the pixel format.
Uint8 r the red component of the pixel in the range 0-255.
Uint8 g the green component of the pixel in the range 0-255.
Uint8 b the blue component of the pixel in the range 0-255.

Return Value

(Uint32) Returns a pixel value.

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

Version

This function is available since SDL 2.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryPixels


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.