ColorFromPalette() [5/8]

CRGB ColorFromPalette	(	const CRGBPalette256 &	pal,
		uint8_t	index,
		uint8_t	brightness = 255,
		TBlendType	blendType = NOBLEND )

Get a color from a palette.

These are the main functions for getting and using palette colors. Regardless of the number of entries in the base palette, this function will interpolate between entries to turn the discrete colors into a smooth gradient.

Parameters

pal	the palette to retrieve the color from
index	the position in the palette to retrieve the color for (0-255)
brightness	optional brightness value to scale the resulting color
blendType	whether to take the palette entries directly (NOBLEND) or blend linearly between palette entries (LINEARBLEND)

Definition at line 1046 of file colorutils.cpp.

{
    const CRGB* entry = &(pal[0]) + index;
 
    uint8_t red   = entry->red;
    uint8_t green = entry->green;
    uint8_t blue  = entry->blue;
 
    if( brightness != 255) {
        ++brightness; // adjust for rounding
        red   = scale8_video_LEAVING_R1_DIRTY( red,   brightness);
        green = scale8_video_LEAVING_R1_DIRTY( green, brightness);
        blue  = scale8_video_LEAVING_R1_DIRTY( blue,  brightness);
        cleanup_R1();
    }
 
    return CRGB( red, green, blue);
}

References brightness, cleanup_R1(), and scale8_video_LEAVING_R1_DIRTY().

Here is the call graph for this function: