crgb.h

Go to the documentation of this file.

 
#pragma once
 
#include "fl/stl/int.h"
 
#include "fl/stl/compiler_control.h"
#include "fl/math/ease.h"
// Include color.h for LEDColorCorrection and ColorTemperature enums
// These are needed for constexpr constructors and can't be forward-declared
#include "color.h"
#include "fl/stl/noexcept.h"
 
// Forward declarations
namespace fl {
    class string;
    class XYMap;
    struct HSV16;
    struct hsv8;
}
 
namespace fl {

struct CRGB {
    typedef u8 fp;
    union {
        struct {
            union {
                u8 r;    
                u8 red;  
            };
            union {
                u8 g;      
                u8 green;  
            };
            union {
                u8 b;     
                u8 blue;  
            };
        };

        u8 raw[3];
    };
 
    static CRGB blend(const CRGB& p1, const CRGB& p2, fract8 amountOfP2) FL_NO_EXCEPT;
    static CRGB blendAlphaMaxChannel(const CRGB& upper, const CRGB& lower) FL_NO_EXCEPT;

    static void downscale(const CRGB* src, const XYMap& srcXY, CRGB* dst, const XYMap& dstXY) FL_NO_EXCEPT;
    static void upscale(const CRGB* src, const XYMap& srcXY, CRGB* dst, const XYMap& dstXY) FL_NO_EXCEPT;
 
    // Are you using WS2812 (or other RGB8 LEDS) to display video?
    // Does it look washed out and under-saturated?
    //
    // Have you tried gamma correction but hate how it decimates the color into 8 colors per component?
    //
    // This is an alternative to gamma correction that preserves the hue but boosts the saturation.
    //
    // decimating the color from 8 bit -> gamma -> 8 bit (leaving only 8 colors for each component).
    // work well with WS2812 (and other RGB8) led displays.
    // This function converts to HSV16, boosts the saturation, and converts back to RGB8.
    // Note that when both boost_saturation and boost_contrast are true the resulting
    // pixel will be nearly the same as if you had used gamma correction pow = 2.0.
    CRGB colorBoost(EaseType saturation_function = EaseType::EASE_NONE, EaseType luminance_function = EaseType::EASE_NONE) const FL_NO_EXCEPT;
    static void colorBoost(const CRGB* src, CRGB* dst, size_t count, EaseType saturation_function = EaseType::EASE_NONE, EaseType luminance_function = EaseType::EASE_NONE) FL_NO_EXCEPT;
 
    // Want to do advanced color manipulation in HSV and write back to CRGB?
    // You want to use HSV16, which is much better at preservering the color
    // space than hsv8.
    HSV16 toHSV16() const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE u8& operator[] (u8 x) FL_NO_EXCEPT
    {
        return raw[x];
    }

    FASTLED_FORCE_INLINE const u8& operator[] (u8 x) const FL_NO_EXCEPT
    {
        return raw[x];
    }
 
    #if defined(FL_IS_AVR)
    // Saves a surprising amount of memory on AVR devices.
    CRGB() FL_NO_EXCEPT = default;
    #else
    FASTLED_FORCE_INLINE CRGB() FL_NO_EXCEPT {
        r = 0;
        g = 0;
        b = 0;
    }
    #endif

    constexpr CRGB(u8 ir, u8 ig, u8 ib) FL_NO_EXCEPT
        : r(ir), g(ig), b(ib)
    {
    }

    constexpr CRGB(u32 colorcode) FL_NO_EXCEPT
    : r((colorcode >> 16) & 0xFF), g((colorcode >> 8) & 0xFF), b((colorcode >> 0) & 0xFF)
    {
    }
 
    constexpr u32 as_uint32_t() const FL_NO_EXCEPT {
        return u32(0xff000000) |
               (u32{r} << 16) |
               (u32{g} << 8) |
               u32{b};
    }

    constexpr CRGB(LEDColorCorrection colorcode) FL_NO_EXCEPT
    : r((colorcode >> 16) & 0xFF), g((colorcode >> 8) & 0xFF), b((colorcode >> 0) & 0xFF)
    {
    }

    constexpr CRGB(ColorTemperature colorcode) FL_NO_EXCEPT
    : r((colorcode >> 16) & 0xFF), g((colorcode >> 8) & 0xFF), b((colorcode >> 0) & 0xFF)
    {
    }

    FASTLED_FORCE_INLINE CRGB(const CRGB& rhs) = default;

    CRGB(const hsv8& rhs) FL_NO_EXCEPT;

    CRGB(const HSV16& rhs) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator= (const CRGB& rhs) FL_NO_EXCEPT = default;

    FASTLED_FORCE_INLINE CRGB& operator= (const u32 colorcode) FL_NO_EXCEPT
    {
        r = (colorcode >> 16) & 0xFF;
        g = (colorcode >>  8) & 0xFF;
        b = (colorcode >>  0) & 0xFF;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& setRGB (u8 nr, u8 ng, u8 nb) FL_NO_EXCEPT
    {
        r = nr;
        g = ng;
        b = nb;
        return *this;
    }

    CRGB& setHSV (u8 hue, u8 sat, u8 val) FL_NO_EXCEPT;

    CRGB& setHue (u8 hue) FL_NO_EXCEPT;

    CRGB& operator= (const hsv8& rhs) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& setColorCode (u32 colorcode) FL_NO_EXCEPT
    {
        r = (colorcode >> 16) & 0xFF;
        g = (colorcode >>  8) & 0xFF;
        b = (colorcode >>  0) & 0xFF;
        return *this;
    }

    CRGB& operator+= (const CRGB& rhs) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& addToRGB (u8 d) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator-= (const CRGB& rhs) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& subtractFromRGB(u8 d) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator-- () FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB operator-- (int ) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator++ () FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB operator++ (int ) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator/= (u8 d ) FL_NO_EXCEPT
    {
        r /= d;
        g /= d;
        b /= d;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& operator>>= (u8 d) FL_NO_EXCEPT
    {
        r >>= d;
        g >>= d;
        b >>= d;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& operator*= (u8 d) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& nscale8_video (u8 scaledown) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator%= (u8 scaledown) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& fadeLightBy (u8 fadefactor ) FL_NO_EXCEPT;

    CRGB& nscale8 (u8 scaledown ) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& nscale(u8 scaledown) FL_NO_EXCEPT { return nscale8(scaledown); }

    FASTLED_FORCE_INLINE CRGB& nscale8 (const CRGB & scaledown ) FL_NO_EXCEPT;
 
    constexpr CRGB nscale8_constexpr (const CRGB scaledown ) const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB scale8 (u8 scaledown ) const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB scale8 (const CRGB & scaledown ) const FL_NO_EXCEPT;

    CRGB& fadeToBlackBy (u8 fadefactor ) FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB& operator|= (const CRGB& rhs ) FL_NO_EXCEPT
    {
        if( rhs.r > r) r = rhs.r;
        if( rhs.g > g) g = rhs.g;
        if( rhs.b > b) b = rhs.b;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& operator|= (u8 d ) FL_NO_EXCEPT
    {
        if( d > r) r = d;
        if( d > g) g = d;
        if( d > b) b = d;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& operator&= (const CRGB& rhs ) FL_NO_EXCEPT
    {
        if( rhs.r < r) r = rhs.r;
        if( rhs.g < g) g = rhs.g;
        if( rhs.b < b) b = rhs.b;
        return *this;
    }

    FASTLED_FORCE_INLINE CRGB& operator&= (u8 d ) FL_NO_EXCEPT
    {
        if( d < r) r = d;
        if( d < g) g = d;
        if( d < b) b = d;
        return *this;
    }

    constexpr explicit operator bool() const FL_NO_EXCEPT
    {
        return r || g || b;
    }

    constexpr explicit operator u32() const FL_NO_EXCEPT
    {
        return u32(0xff000000) |
               (u32{r} << 16) |
               (u32{g} << 8) |
               u32{b};
    }

    constexpr CRGB operator-() const FL_NO_EXCEPT
    {
        return CRGB(255 - r, 255 - g, 255 - b);
    }
 
#if (defined SmartMatrix_h || defined SmartMatrix3_h)
    operator rgb24() const {
        rgb24 ret;
        ret.red = r;
        ret.green = g;
        ret.blue = b;
        return ret;
    }
#endif
 
    string toString() const FL_NO_EXCEPT;

    u8 getLuma() const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE u8 getAverageLight() const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE void maximizeBrightness( u8 limit = 255 ) FL_NO_EXCEPT {
        u8 max = red;
        if( green > max) max = green;
        if( blue > max) max = blue;
 
        // stop div/0 when color is black
        if(max > 0) {
            u16 factor = ((u16)(limit) * 256) / max;
            red =   (red   * factor) / 256;
            green = (green * factor) / 256;
            blue =  (blue  * factor) / 256;
        }
    }

    static CRGB computeAdjustment(u8 scale, const CRGB & colorCorrection, const CRGB & colorTemperature) FL_NO_EXCEPT;

    CRGB lerp8( const CRGB& other, fract8 amountOf2) const FL_NO_EXCEPT;

    FASTLED_FORCE_INLINE CRGB lerp16( const CRGB& other, fract16 frac) const FL_NO_EXCEPT;
    FASTLED_FORCE_INLINE u8 getParity() FL_NO_EXCEPT
    {
        u8 sum = r + g + b;
        return (sum & 0x01);
    }

    FASTLED_FORCE_INLINE void setParity( u8 parity) FL_NO_EXCEPT
    {
        u8 curparity = getParity();
 
        if( parity == curparity) return;
 
        if( parity ) {
            // going 'up'
            if( (b > 0) && (b < 255)) {
                if( r == g && g == b) {
                    ++r;
                    ++g;
                }
                ++b;
            } else if( (r > 0) && (r < 255)) {
                ++r;
            } else if( (g > 0) && (g < 255)) {
                ++g;
            } else {
                if( r == g && g == b) {
                    r ^= 0x01;
                    g ^= 0x01;
                }
                b ^= 0x01;
            }
        } else {
            // going 'down'
            if( b > 1) {
                if( r == g && g == b) {
                    --r;
                    --g;
                }
                --b;
            } else if( g > 1) {
                --g;
            } else if( r > 1) {
                --r;
            } else {
                if( r == g && g == b) {
                    r ^= 0x01;
                    g ^= 0x01;
                }
                b ^= 0x01;
            }
        }
    }

    typedef enum {
        AliceBlue=0xF0F8FF,             
        Amethyst=0x9966CC,              
        AntiqueWhite=0xFAEBD7,          
        Aqua=0x00FFFF,                  
        Aquamarine=0x7FFFD4,            
        Azure=0xF0FFFF,                 
        Beige=0xF5F5DC,                 
        Bisque=0xFFE4C4,                
        Black=0x000000,                 
        BlanchedAlmond=0xFFEBCD,        
        Blue=0x0000FF,                  
        BlueViolet=0x8A2BE2,            
        Brown=0xA52A2A,                 
        BurlyWood=0xDEB887,             
        CadetBlue=0x5F9EA0,             
        Chartreuse=0x7FFF00,            
        Chocolate=0xD2691E,             
        Coral=0xFF7F50,                 
        CornflowerBlue=0x6495ED,        
        Cornsilk=0xFFF8DC,              
        Crimson=0xDC143C,               
        Cyan=0x00FFFF,                  
        DarkBlue=0x00008B,              
        DarkCyan=0x008B8B,              
        DarkGoldenrod=0xB8860B,         
        DarkGray=0xA9A9A9,              
        DarkGrey=0xA9A9A9,              
        DarkGreen=0x006400,             
        DarkKhaki=0xBDB76B,             
        DarkMagenta=0x8B008B,           
        DarkOliveGreen=0x556B2F,        
        DarkOrange=0xFF8C00,            
        DarkOrchid=0x9932CC,            
        DarkRed=0x8B0000,               
        DarkSalmon=0xE9967A,            
        DarkSeaGreen=0x8FBC8F,          
        DarkSlateBlue=0x483D8B,         
        DarkSlateGray=0x2F4F4F,         
        DarkSlateGrey=0x2F4F4F,         
        DarkTurquoise=0x00CED1,         
        DarkViolet=0x9400D3,            
        DeepPink=0xFF1493,              
        DeepSkyBlue=0x00BFFF,           
        DimGray=0x696969,               
        DimGrey=0x696969,               
        DodgerBlue=0x1E90FF,            
        FireBrick=0xB22222,             
        FloralWhite=0xFFFAF0,           
        ForestGreen=0x228B22,           
        Fuchsia=0xFF00FF,               
        Gainsboro=0xDCDCDC,             
        GhostWhite=0xF8F8FF,            
        Gold=0xFFD700,                  
        Goldenrod=0xDAA520,             
        Gray=0x808080,                  
        Grey=0x808080,                  
        Green=0x008000,                 
        GreenYellow=0xADFF2F,           
        Honeydew=0xF0FFF0,              
        HotPink=0xFF69B4,               
        IndianRed=0xCD5C5C,             
        Indigo=0x4B0082,                
        Ivory=0xFFFFF0,                 
        Khaki=0xF0E68C,                 
        Lavender=0xE6E6FA,              
        LavenderBlush=0xFFF0F5,         
        LawnGreen=0x7CFC00,             
        LemonChiffon=0xFFFACD,          
        LightBlue=0xADD8E6,             
        LightCoral=0xF08080,            
        LightCyan=0xE0FFFF,             
        LightGoldenrodYellow=0xFAFAD2,  
        LightGreen=0x90EE90,            
        LightGrey=0xD3D3D3,             
        LightPink=0xFFB6C1,             
        LightSalmon=0xFFA07A,           
        LightSeaGreen=0x20B2AA,         
        LightSkyBlue=0x87CEFA,          
        LightSlateGray=0x778899,        
        LightSlateGrey=0x778899,        
        LightSteelBlue=0xB0C4DE,        
        LightYellow=0xFFFFE0,           
        Lime=0x00FF00,                  
        LimeGreen=0x32CD32,             
        Linen=0xFAF0E6,                 
        Magenta=0xFF00FF,               
        Maroon=0x800000,                
        MediumAquamarine=0x66CDAA,      
        MediumBlue=0x0000CD,            
        MediumOrchid=0xBA55D3,          
        MediumPurple=0x9370DB,          
        MediumSeaGreen=0x3CB371,        
        MediumSlateBlue=0x7B68EE,       
        MediumSpringGreen=0x00FA9A,     
        MediumTurquoise=0x48D1CC,       
        MediumVioletRed=0xC71585,       
        MidnightBlue=0x191970,          
        MintCream=0xF5FFFA,             
        MistyRose=0xFFE4E1,             
        Moccasin=0xFFE4B5,              
        NavajoWhite=0xFFDEAD,           
        Navy=0x000080,                  
        OldLace=0xFDF5E6,               
        Olive=0x808000,                 
        OliveDrab=0x6B8E23,             
        Orange=0xFFA500,                
        OrangeRed=0xFF4500,             
        Orchid=0xDA70D6,                
        PaleGoldenrod=0xEEE8AA,         
        PaleGreen=0x98FB98,             
        PaleTurquoise=0xAFEEEE,         
        PaleVioletRed=0xDB7093,         
        PapayaWhip=0xFFEFD5,            
        PeachPuff=0xFFDAB9,             
        Peru=0xCD853F,                  
        Pink=0xFFC0CB,                  
        Plaid=0xCC5533,                 
        Plum=0xDDA0DD,                  
        PowderBlue=0xB0E0E6,            
        Purple=0x800080,                
        Red=0xFF0000,                   
        RosyBrown=0xBC8F8F,             
        RoyalBlue=0x4169E1,             
        SaddleBrown=0x8B4513,           
        Salmon=0xFA8072,                
        SandyBrown=0xF4A460,            
        SeaGreen=0x2E8B57,              
        Seashell=0xFFF5EE,              
        Sienna=0xA0522D,                
        Silver=0xC0C0C0,                
        SkyBlue=0x87CEEB,               
        SlateBlue=0x6A5ACD,             
        SlateGray=0x708090,             
        SlateGrey=0x708090,             
        Snow=0xFFFAFA,                  
        SpringGreen=0x00FF7F,           
        SteelBlue=0x4682B4,             
        Tan=0xD2B48C,                   
        Teal=0x008080,                  
        Thistle=0xD8BFD8,               
        Tomato=0xFF6347,                
        Turquoise=0x40E0D0,             
        Violet=0xEE82EE,                
        Wheat=0xF5DEB3,                 
        White=0xFFFFFF,                 
        WhiteSmoke=0xF5F5F5,            
        Yellow=0xFFFF00,                
        YellowGreen=0x9ACD32,           
 
        // LED RGB color that roughly approximates
        // the color of incandescent fairy lights,
        // assuming that you're using FastLED
        // color correction on your LEDs (recommended).
        FairyLight=0xFFE42D,           
 
        // If you are using no color correction, use this
        FairyLightNCC=0xFF9D2A,         
 
        // TCL Color Extensions - Essential additions for LED programming
        // These colors provide useful grayscale levels and color variants
 
        // Essential grayscale levels (0-100 scale for precise dimming)
        Gray0=0x000000,                
        Gray10=0x1A1A1A,               
        Gray25=0x404040,               
        Gray50=0x7F7F7F,               
        Gray75=0xBFBFBF,               
        Gray100=0xFFFFFF,              
 
        // Alternative grey spellings
        Grey0=0x000000,                
        Grey10=0x1A1A1A,               
        Grey25=0x404040,               
        Grey50=0x7F7F7F,               
        Grey75=0xBFBFBF,               
        Grey100=0xFFFFFF,              
 
        // Primary color variants (1-4 intensity levels)
        Red1=0xFF0000,                 
        Red2=0xEE0000,                 
        Red3=0xCD0000,                 
        Red4=0x8B0000,                 
 
        Green1=0x00FF00,               
        Green2=0x00EE00,               
        Green3=0x00CD00,               
        Green4=0x008B00,               
 
        Blue1=0x0000FF,                
        Blue2=0x0000EE,                
        Blue3=0x0000CD,                
        Blue4=0x00008B,                
 
        // Useful warm color variants for LED ambience
        Orange1=0xFFA500,              
        Orange2=0xEE9A00,              
        Orange3=0xCD8500,              
        Orange4=0x8B5A00,              
 
        Yellow1=0xFFFF00,              
        Yellow2=0xEEEE00,              
        Yellow3=0xCDCD00,              
        Yellow4=0x8B8B00,              
 
        // Popular LED colors for effects
        Cyan1=0x00FFFF,                
        Cyan2=0x00EEEE,                
        Cyan3=0x00CDCD,                
        Cyan4=0x008B8B,                
 
        Magenta1=0xFF00FF,             
        Magenta2=0xEE00EE,             
        Magenta3=0xCD00CD,             
        Magenta4=0x8B008B,             
 
        // Additional useful colors for LED programming
        VioletRed=0xD02090,            
        DeepPink1=0xFF1493,            
        DeepPink2=0xEE1289,            
        DeepPink3=0xCD1076,            
        DeepPink4=0x8B0A50,            
 
        Gold1=0xFFD700,                
        Gold2=0xEEC900,                
        Gold3=0xCDAD00,                
        Gold4=0x8B7500                 
 
    } HTMLColorCode;
};

FASTLED_FORCE_INLINE bool operator== (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    return (lhs.r == rhs.r) && (lhs.g == rhs.g) && (lhs.b == rhs.b);
}

FASTLED_FORCE_INLINE bool operator!= (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    return !(lhs == rhs);
}

FASTLED_FORCE_INLINE bool operator< (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    u16 sl, sr;
    sl = lhs.r + lhs.g + lhs.b;
    sr = rhs.r + rhs.g + rhs.b;
    return sl < sr;
}

FASTLED_FORCE_INLINE bool operator> (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    u16 sl, sr;
    sl = lhs.r + lhs.g + lhs.b;
    sr = rhs.r + rhs.g + rhs.b;
    return sl > sr;
}

FASTLED_FORCE_INLINE bool operator>= (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    u16 sl, sr;
    sl = lhs.r + lhs.g + lhs.b;
    sr = rhs.r + rhs.g + rhs.b;
    return sl >= sr;
}

FASTLED_FORCE_INLINE bool operator<= (const CRGB& lhs, const CRGB& rhs) FL_NO_EXCEPT
{
    u16 sl, sr;
    sl = lhs.r + lhs.g + lhs.b;
    sr = rhs.r + rhs.g + rhs.b;
    return sl <= sr;
}

FASTLED_FORCE_INLINE CRGB operator/( const CRGB& p1, u8 d) FL_NO_EXCEPT
{
    return CRGB( p1.r/d, p1.g/d, p1.b/d);
}

FASTLED_FORCE_INLINE CRGB operator&( const CRGB& p1, const CRGB& p2) FL_NO_EXCEPT
{
    return CRGB( p1.r < p2.r ? p1.r : p2.r,
                 p1.g < p2.g ? p1.g : p2.g,
                 p1.b < p2.b ? p1.b : p2.b);
}

FASTLED_FORCE_INLINE CRGB operator|( const CRGB& p1, const CRGB& p2) FL_NO_EXCEPT
{
    return CRGB( p1.r > p2.r ? p1.r : p2.r,
                 p1.g > p2.g ? p1.g : p2.g,
                 p1.b > p2.b ? p1.b : p2.b);
}

FASTLED_FORCE_INLINE CRGB operator+( const CRGB& p1, const CRGB& p2) FL_NO_EXCEPT;

FASTLED_FORCE_INLINE CRGB operator-( const CRGB& p1, const CRGB& p2) FL_NO_EXCEPT;

FASTLED_FORCE_INLINE CRGB operator*( const CRGB& p1, u8 d) FL_NO_EXCEPT;

FASTLED_FORCE_INLINE CRGB operator%( const CRGB& p1, u8 d) FL_NO_EXCEPT;

 
}  // namespace fl