fill.h

Go to the documentation of this file.

#pragma once
 
#include "fl/gfx/colorutils_misc.h"
#include "fl/stl/int.h"
#include "fl/stl/span.h"
 
#include "fl/stl/compiler_control.h"
#include "fl/stl/noexcept.h"
 
FL_DISABLE_WARNING_PUSH
FL_DISABLE_WARNING_UNUSED_PARAMETER
FL_DISABLE_WARNING_RETURN_TYPE
FL_DISABLE_WARNING_IMPLICIT_INT_CONVERSION
FL_DISABLE_WARNING_FLOAT_CONVERSION
FL_DISABLE_WARNING_SIGN_CONVERSION

#define saccum87 i16
 
namespace fl {



void fill_solid(CRGB *targetArray, int numToFill,
                const CRGB &color) FL_NOEXCEPT;

inline void fill_solid(fl::span<CRGB> leds, const CRGB &color) FL_NOEXCEPT {
    fill_solid(leds.data(), static_cast<int>(leds.size()), color);
}

void fill_solid(CHSV *targetArray, int numToFill,
                const CHSV &color) FL_NOEXCEPT;

void fill_rainbow(CRGB *targetArray, int numToFill, fl::u8 initialhue,
                  fl::u8 deltahue = 5) FL_NOEXCEPT;

inline void fill_rainbow(fl::span<CRGB> leds, fl::u8 initialhue,
                         fl::u8 deltahue = 5) FL_NOEXCEPT {
    fill_rainbow(leds.data(), static_cast<int>(leds.size()), initialhue, deltahue);
}

void fill_rainbow(CHSV *targetArray, int numToFill, fl::u8 initialhue,
                  fl::u8 deltahue = 5) FL_NOEXCEPT;

void fill_rainbow_circular(CRGB *targetArray, int numToFill,
                           fl::u8 initialhue, bool reversed = false) FL_NOEXCEPT;

inline void fill_rainbow_circular(fl::span<CRGB> leds, fl::u8 initialhue,
                                  bool reversed = false) FL_NOEXCEPT {
    fill_rainbow_circular(leds.data(), static_cast<int>(leds.size()),
                          initialhue, reversed);
}

void fill_rainbow_circular(CHSV *targetArray, int numToFill,
                           fl::u8 initialhue, bool reversed = false) FL_NOEXCEPT;

template <typename T>
void fill_gradient(T *targetArray, u16 startpos, CHSV startcolor,
                   u16 endpos, CHSV endcolor,
                   TGradientDirectionCode directionCode = SHORTEST_HUES) FL_NOEXCEPT {
    // if the points are in the wrong order, straighten them
    if (endpos < startpos) {
        u16 t = endpos;
        CHSV tc = endcolor;
        endcolor = startcolor;
        endpos = startpos;
        startpos = t;
        startcolor = tc;
    }
 
    // If we're fading toward black (val=0) or white (sat=0),
    // then set the endhue to the starthue.
    // This lets us ramp smoothly to black or white, regardless
    // of what 'hue' was set in the endcolor (since it doesn't matter)
    if (endcolor.value == 0 || endcolor.saturation == 0) {
        endcolor.hue = startcolor.hue;
    }
 
    // Similarly, if we're fading in from black (val=0) or white (sat=0)
    // then set the starthue to the endhue.
    // This lets us ramp smoothly up from black or white, regardless
    // of what 'hue' was set in the startcolor (since it doesn't matter)
    if (startcolor.value == 0 || startcolor.saturation == 0) {
        startcolor.hue = endcolor.hue;
    }
 
    saccum87 huedistance87;
    saccum87 satdistance87;
    saccum87 valdistance87;
 
    satdistance87 = (endcolor.sat - startcolor.sat) << 7;
    valdistance87 = (endcolor.val - startcolor.val) << 7;
 
    fl::u8 huedelta8 = endcolor.hue - startcolor.hue;
 
    if (directionCode == SHORTEST_HUES) {
        directionCode = FORWARD_HUES;
        if (huedelta8 > 127) {
            directionCode = BACKWARD_HUES;
        }
    }
 
    if (directionCode == LONGEST_HUES) {
        directionCode = FORWARD_HUES;
        if (huedelta8 < 128) {
            directionCode = BACKWARD_HUES;
        }
    }
 
    if (directionCode == FORWARD_HUES) {
        huedistance87 = huedelta8 << 7;
    } else /* directionCode == BACKWARD_HUES */
    {
        huedistance87 = (fl::u8)(256 - huedelta8) << 7;
        huedistance87 = -huedistance87;
    }
 
    u16 pixeldistance = endpos - startpos;
    i16 divisor = pixeldistance ? pixeldistance : 1;
 
#if FASTLED_USE_32_BIT_GRADIENT_FILL
    // Use higher precision 32 bit math for new micros.
    i32 huedelta823 = (huedistance87 * 65536) / divisor;
    i32 satdelta823 = (satdistance87 * 65536) / divisor;
    i32 valdelta823 = (valdistance87 * 65536) / divisor;
 
    huedelta823 *= 2;
    satdelta823 *= 2;
    valdelta823 *= 2;
    u32 hue824 = static_cast<u32>(startcolor.hue) << 24;
    u32 sat824 = static_cast<u32>(startcolor.sat) << 24;
    u32 val824 = static_cast<u32>(startcolor.val) << 24;
    for (u16 i = startpos; i <= endpos; ++i) {
        targetArray[i] = CHSV(hue824 >> 24, sat824 >> 24, val824 >> 24);
        hue824 += huedelta823;
        sat824 += satdelta823;
        val824 += valdelta823;
    }
#else
    // Use 8-bit math for older micros.
    saccum87 huedelta87 = huedistance87 / divisor;
    saccum87 satdelta87 = satdistance87 / divisor;
    saccum87 valdelta87 = valdistance87 / divisor;
 
    huedelta87 *= 2;
    satdelta87 *= 2;
    valdelta87 *= 2;
 
    accum88 hue88 = startcolor.hue << 8;
    accum88 sat88 = startcolor.sat << 8;
    accum88 val88 = startcolor.val << 8;
    for (u16 i = startpos; i <= endpos; ++i) {
        targetArray[i] = CHSV(hue88 >> 8, sat88 >> 8, val88 >> 8);
        hue88 += huedelta87;
        sat88 += satdelta87;
        val88 += valdelta87;
    }
#endif // defined(FL_IS_AVR)
}

template <typename T>
void fill_gradient(T *targetArray, u16 numLeds, const CHSV &c1,
                   const CHSV &c2,
                   TGradientDirectionCode directionCode = SHORTEST_HUES) FL_NOEXCEPT {
    u16 last = numLeds - 1;
    fill_gradient(targetArray, 0, c1, last, c2, directionCode);
}

template <typename T>
void fill_gradient(T *targetArray, u16 numLeds, const CHSV &c1,
                   const CHSV &c2, const CHSV &c3,
                   TGradientDirectionCode directionCode = SHORTEST_HUES) FL_NOEXCEPT {
    u16 half = (numLeds / 2);
    u16 last = numLeds - 1;
    fill_gradient(targetArray, 0, c1, half, c2, directionCode);
    fill_gradient(targetArray, half, c2, last, c3, directionCode);
}

template <typename T>
void fill_gradient(T *targetArray, u16 numLeds, const CHSV &c1,
                   const CHSV &c2, const CHSV &c3, const CHSV &c4,
                   TGradientDirectionCode directionCode = SHORTEST_HUES) FL_NOEXCEPT {
    u16 onethird = (numLeds / 3);
    u16 twothirds = ((numLeds * 2) / 3);
    u16 last = numLeds - 1;
    fill_gradient(targetArray, 0, c1, onethird, c2, directionCode);
    fill_gradient(targetArray, onethird, c2, twothirds, c3, directionCode);
    fill_gradient(targetArray, twothirds, c3, last, c4, directionCode);
}

#define fill_gradient_HSV fill_gradient

void fill_gradient_RGB(CRGB *leds, u16 startpos, CRGB startcolor,
                       u16 endpos, CRGB endcolor) FL_NOEXCEPT;

void fill_gradient_RGB(CRGB *leds, u16 numLeds, const CRGB &c1,
                       const CRGB &c2) FL_NOEXCEPT;

void fill_gradient_RGB(CRGB *leds, u16 numLeds, const CRGB &c1,
                       const CRGB &c2, const CRGB &c3) FL_NOEXCEPT;

void fill_gradient_RGB(CRGB *leds, u16 numLeds, const CRGB &c1,
                       const CRGB &c2, const CRGB &c3, const CRGB &c4) FL_NOEXCEPT;

inline void fill_gradient_RGB(fl::span<CRGB> leds, const CRGB &c1,
                               const CRGB &c2) FL_NOEXCEPT {
    fill_gradient_RGB(leds.data(), static_cast<u16>(leds.size()), c1, c2);
}

inline void fill_gradient_RGB(fl::span<CRGB> leds, const CRGB &c1,
                               const CRGB &c2, const CRGB &c3) FL_NOEXCEPT {
    fill_gradient_RGB(leds.data(), static_cast<u16>(leds.size()), c1, c2, c3);
}

inline void fill_gradient_RGB(fl::span<CRGB> leds, const CRGB &c1,
                               const CRGB &c2, const CRGB &c3,
                               const CRGB &c4) FL_NOEXCEPT {
    fill_gradient_RGB(leds.data(), static_cast<u16>(leds.size()), c1, c2, c3,
                      c4);
}
 
} // namespace fl
 
FL_DISABLE_WARNING_POP