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

SDL_GetRGB

Get RGB values from a pixel in the specified format.

Header File

Syntax

void SDL_GetRGB(Uint32 pixel,
                const SDL_PixelFormat * format,
                Uint8 * r, Uint8 * g, Uint8 * b);

Function Parameters

Uint32	pixel	a pixel value.
const SDL_PixelFormat *	format	an SDL_PixelFormat structure describing the format of the pixel.
Uint8 *	r	a pointer filled in with the red component.
Uint8 *	g	a pointer filled in with the green component.
Uint8 *	b	a pointer filled in with the blue component.

Remarks

This function uses the entire 8-bit [0..255] range when converting color components from pixel formats with less than 8-bits per RGB component (e.g., a completely white pixel in 16-bit RGB565 format would return [0xff, 0xff, 0xff] not [0xf8, 0xfc, 0xf8]).

Version

This function is available since SDL 2.0.0.