fill_palette_circular()

template<typename PALETTE>

void fill_palette_circular	(	CRGB *	L,
		uint16_t	N,
		uint8_t	startIndex,
		const PALETTE &	pal,
		uint8_t	brightness = 255,
		TBlendType	blendType = LINEARBLEND,
		bool	reversed = false )

Fill a range of LEDs with a sequence of entries from a palette, so that the entire palette smoothly covers the range of LEDs.

Template Parameters

PALETTE

the type of the palette used (auto-deduced)

Parameters

L	pointer to the LED array to fill
N	number of LEDs to fill in the array
startIndex	the starting color index in the palette
pal	the color palette to pull colors from
brightness	brightness value used to scale the resulting color
blendType	whether to take the palette entries directly (NOBLEND) or blend linearly between palette entries (LINEARBLEND)
reversed	whether to progress through the palette backwards

Definition at line 2117 of file colorutils.h.

{
    if (N == 0) return;  // avoiding div/0
 
    const uint16_t colorChange = 65535 / N;              // color change for each LED, * 256 for precision
    uint16_t colorIndex = ((uint16_t) startIndex) << 8;  // offset for color index, with precision (*256)
 
   for (uint16_t i = 0; i < N; ++i) {
        L[i] = ColorFromPalette(pal, (colorIndex >> 8), brightness, blendType);
        if (reversed) colorIndex -= colorChange;
        else colorIndex += colorChange;
    }
}

References brightness, ColorFromPalette(), and LINEARBLEND.

Here is the call graph for this function: