Loading...
Searching...
No Matches
Detailed Description
Utility functions for color fill, palettes, blending, and more.
Definition in file colorutils.h.
#include "FastLED.h"#include "pixeltypes.h"#include "fastled_progmem.h"#include "fl/xymap.h"#include "fl/deprecated.h"
Include dependency graph for colorutils.h: This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Classes | |
| class | CHSVPalette16 |
| HSV color palette with 16 discrete values. More... | |
| class | CHSVPalette256 |
| HSV color palette with 256 discrete values. More... | |
| class | CHSVPalette32 |
| HSV color palette with 32 discrete values. More... | |
| class | CRGBPalette16 |
| RGB color palette with 16 discrete values. More... | |
| class | CRGBPalette256 |
| RGB color palette with 256 discrete values. More... | |
| class | CRGBPalette32 |
| RGB color palette with 32 discrete values. More... | |
| union | TRGBGradientPaletteEntryUnion |
| Struct for digesting gradient pointer data into its components. More... | |
| struct | TRGBGradientPaletteEntryUnion.__unnamed0__ |
Macros | |
| #define | DECLARE_GRADIENT_PALETTE(X) |
| Forward-declaration macro for DEFINE_GRADIENT_PALETTE(X) | |
| #define | DEFINE_GRADIENT_PALETTE(X) |
| Defines a static RGB palette very compactly using a series of connected color gradients. | |
| #define | fill_gradient_HSV fill_gradient |
| Convenience synonym. | |
| #define | saccum87 int16_t |
| ANSI: signed short _Accum. | |
| #define | TProgmemPalette16 TProgmemRGBPalette16 |
| Alias for TProgmemRGBPalette16. | |
| #define | TProgmemPalette32 TProgmemRGBPalette32 |
| Alias for TProgmemRGBPalette32. | |
Typedefs | |
| typedef uint8_t | TDynamicRGBGradientPalette_byte |
| Byte of an RGB gradient entry, stored in dynamic (heap) memory. | |
| typedef const TDynamicRGBGradientPalette_byte * | TDynamicRGBGradientPalette_bytes |
| Pointer to bytes of an RGB gradient, stored in dynamic (heap) memory. | |
| typedef TDynamicRGBGradientPalette_bytes | TDynamicRGBGradientPaletteRef |
| Alias of TDynamicRGBGradientPalette_bytes. | |
| typedef uint32_t | TProgmemHSVPalette16[16] |
| CHSVPalette16 entries stored in PROGMEM memory. | |
| typedef uint32_t | TProgmemHSVPalette32[32] |
| CHSVPalette32 entries stored in PROGMEM memory. | |
| typedef const uint8_t | TProgmemRGBGradientPalette_byte |
| Byte of an RGB gradient, stored in PROGMEM memory. | |
| typedef const TProgmemRGBGradientPalette_byte * | TProgmemRGBGradientPalette_bytes |
| Pointer to bytes of an RGB gradient, stored in PROGMEM memory. | |
| typedef TProgmemRGBGradientPalette_bytes | TProgmemRGBGradientPaletteRef |
| Alias of TProgmemRGBGradientPalette_bytes. | |
| typedef uint32_t | TProgmemRGBPalette16[16] |
| CRGBPalette16 entries stored in PROGMEM memory. | |
| typedef uint32_t | TProgmemRGBPalette32[32] |
| CRGBPalette32 entries stored in PROGMEM memory. | |
Enumerations | |
| enum | TBlendType { NOBLEND =0 , LINEARBLEND =1 , LINEARBLEND_NOWRAP =2 } |
| Color interpolation options for palette. More... | |
| enum | TGradientDirectionCode { FORWARD_HUES , BACKWARD_HUES , SHORTEST_HUES , LONGEST_HUES } |
| Hue direction for calculating fill gradients. More... | |
Functions | |
| CRGB | applyGamma_video (const CRGB &orig, float gamma) |
| Applies a gamma adjustment to a color. | |
| CRGB | applyGamma_video (const CRGB &orig, float gammaR, float gammaG, float gammaB) |
| Applies a gamma adjustment to a color. | |
| uint8_t | applyGamma_video (uint8_t brightness, float gamma) |
| Applies a gamma adjustment to a color channel. | |
| CHSV | blend (const CHSV &p1, const CHSV &p2, fract8 amountOfP2, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Computes a new color blended some fraction of the way between two other colors. | |
| CHSV * | blend (const CHSV *src1, const CHSV *src2, CHSV *dest, uint16_t count, fract8 amountOfsrc2, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Computes a new blended array of colors, each some fraction of the way between corresponding elements of two source arrays of colors. | |
| CRGB | blend (const CRGB &p1, const CRGB &p2, fract8 amountOfP2) |
| Computes a new color blended some fraction of the way between two other colors. | |
| CRGB * | blend (const CRGB *src1, const CRGB *src2, CRGB *dest, uint16_t count, fract8 amountOfsrc2) |
| Computes a new blended array of colors, each some fraction of the way between corresponding elements of two source arrays of colors. | |
| void | blur1d (CRGB *leds, uint16_t numLeds, fract8 blur_amount) |
| One-dimensional blur filter. | |
| void | blur2d (CRGB *leds, uint8_t width, uint8_t height, fract8 blur_amount) FASTLED_DEPRECATED("Use blur2d(... |
| Legacy version of blur2d, which does not require an XYMap but instead implicitly binds to XY() function. | |
| void | blur2d (CRGB *leds, uint8_t width, uint8_t height, fract8 blur_amount, const fl::XYMap &xymap) |
| Two-dimensional blur filter. | |
| void | blurColumns (CRGB *leds, uint8_t width, uint8_t height, fract8 blur_amount, const fl::XYMap &xymap) |
| Perform a blur1d() on every column of a rectangular matrix. | |
| void | blurRows (CRGB *leds, uint8_t width, uint8_t height, fract8 blur_amount, const fl::XYMap &xymap) |
| Perform a blur1d() on every row of a rectangular matrix. | |
| CHSV | ColorFromPalette (const CHSVPalette16 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CHSV | ColorFromPalette (const CHSVPalette256 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=NOBLEND) |
| Get a color from a palette. | |
| CHSV | ColorFromPalette (const CHSVPalette32 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPalette (const CRGBPalette16 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPalette (const CRGBPalette256 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=NOBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPalette (const CRGBPalette32 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPalette (const TProgmemRGBPalette16 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPalette (const TProgmemRGBPalette32 &pal, uint8_t index, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Get a color from a palette. | |
| CRGB | ColorFromPaletteExtended (const CRGBPalette16 &pal, uint16_t index, uint8_t brightness, TBlendType blendType) |
Same as ColorFromPalette, but with uint16_t index to give greater precision. | |
| CRGB | ColorFromPaletteExtended (const CRGBPalette256 &pal, uint16_t index, uint8_t brightness, TBlendType blendType) |
| CRGB | ColorFromPaletteExtended (const CRGBPalette32 &pal, uint16_t index, uint8_t brightness, TBlendType blendType) |
| Same as ColorFromPalette, but higher precision. | |
| void | fade_raw (CRGB *leds, uint16_t num_leds, uint8_t fadeBy) |
| Reduce the brightness of an array of pixels all at once. | |
| void | fade_video (CRGB *leds, uint16_t num_leds, uint8_t fadeBy) |
| Reduce the brightness of an array of pixels all at once. | |
| void | fadeLightBy (CRGB *leds, uint16_t num_leds, uint8_t fadeBy) |
| Reduce the brightness of an array of pixels all at once. | |
| void | fadeToBlackBy (CRGB *leds, uint16_t num_leds, uint8_t fadeBy) |
| Reduce the brightness of an array of pixels all at once. | |
| void | fadeUsingColor (CRGB *leds, uint16_t numLeds, const CRGB &colormask) |
| Reduce the brightness of an array of pixels as thought it were seen through a transparent filter with the specified color. | |
| template<typename T> | |
| void | fill_gradient (T *targetArray, uint16_t numLeds, const CHSV &c1, const CHSV &c2, const CHSV &c3, const CHSV &c4, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Fill a range of LEDs with a smooth HSV gradient between four HSV colors. | |
| template<typename T> | |
| void | fill_gradient (T *targetArray, uint16_t numLeds, const CHSV &c1, const CHSV &c2, const CHSV &c3, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Fill a range of LEDs with a smooth HSV gradient between three HSV colors. | |
| template<typename T> | |
| void | fill_gradient (T *targetArray, uint16_t numLeds, const CHSV &c1, const CHSV &c2, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Fill a range of LEDs with a smooth HSV gradient between two HSV colors. | |
| template<typename T> | |
| void | fill_gradient (T *targetArray, uint16_t startpos, CHSV startcolor, uint16_t endpos, CHSV endcolor, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Fill a range of LEDs with a smooth HSV gradient between two HSV colors. | |
| void | fill_gradient_RGB (CRGB *leds, uint16_t numLeds, const CRGB &c1, const CRGB &c2) |
| Fill a range of LEDs with a smooth RGB gradient between two RGB colors. | |
| void | fill_gradient_RGB (CRGB *leds, uint16_t numLeds, const CRGB &c1, const CRGB &c2, const CRGB &c3) |
| Fill a range of LEDs with a smooth RGB gradient between three RGB colors. | |
| void | fill_gradient_RGB (CRGB *leds, uint16_t numLeds, const CRGB &c1, const CRGB &c2, const CRGB &c3, const CRGB &c4) |
| Fill a range of LEDs with a smooth RGB gradient between four RGB colors. | |
| void | fill_gradient_RGB (CRGB *leds, uint16_t startpos, CRGB startcolor, uint16_t endpos, CRGB endcolor) |
| Fill a range of LEDs with a smooth RGB gradient between two RGB colors. | |
| template<typename PALETTE> | |
| void | fill_palette (CRGB *L, uint16_t N, uint8_t startIndex, uint8_t incIndex, const PALETTE &pal, uint8_t brightness=255, TBlendType blendType=LINEARBLEND) |
| Fill a range of LEDs with a sequence of entries from a palette. | |
| 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. | |
| void | fill_rainbow (struct CHSV *targetArray, int numToFill, uint8_t initialhue, uint8_t deltahue=5) |
| Fill a range of LEDs with a rainbow of colors. | |
| void | fill_rainbow (struct CRGB *targetArray, int numToFill, uint8_t initialhue, uint8_t deltahue=5) |
| Fill a range of LEDs with a rainbow of colors. | |
| void | fill_rainbow_circular (struct CHSV *targetArray, int numToFill, uint8_t initialhue, bool reversed=false) |
| Fill a range of LEDs with a rainbow of colors, so that the hues are continuous between the end of the strip and the beginning. | |
| void | fill_rainbow_circular (struct CRGB *targetArray, int numToFill, uint8_t initialhue, bool reversed=false) |
| Fill a range of LEDs with a rainbow of colors, so that the hues are continuous between the end of the strip and the beginning. | |
| void | fill_solid (struct CHSV *targetArray, int numToFill, const struct CHSV &color) |
| Fill a range of LEDs with a solid color. | |
| void | fill_solid (struct CRGB *targetArray, int numToFill, const struct CRGB &color) |
| Fill a range of LEDs with a solid color. | |
| CRGB | HeatColor (uint8_t temperature) |
| Approximates a "black body radiation" spectrum for a given "heat" level. | |
| template<typename PALETTE> | |
| void | map_data_into_colors_through_palette (uint8_t *dataArray, uint16_t dataCount, CRGB *targetColorArray, const PALETTE &pal, uint8_t brightness=255, uint8_t opacity=255, TBlendType blendType=LINEARBLEND) |
| Maps an array of palette color indexes into an array of LED colors. | |
| CRGB & | napplyGamma_video (CRGB &rgb, float gamma) |
| Destructively applies a gamma adjustment to a color. | |
| CRGB & | napplyGamma_video (CRGB &rgb, float gammaR, float gammaG, float gammaB) |
| Destructively applies a gamma adjustment to a color. | |
| void | napplyGamma_video (CRGB *rgbarray, uint16_t count, float gamma) |
| Destructively applies a gamma adjustment to a color array. | |
| void | napplyGamma_video (CRGB *rgbarray, uint16_t count, float gammaR, float gammaG, float gammaB) |
| Destructively applies a gamma adjustment to a color array. | |
| CHSV & | nblend (CHSV &existing, const CHSV &overlay, fract8 amountOfOverlay, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Destructively modifies one color, blending in a given fraction of an overlay color. | |
| void | nblend (CHSV *existing, const CHSV *overlay, uint16_t count, fract8 amountOfOverlay, TGradientDirectionCode directionCode=SHORTEST_HUES) |
| Destructively blends a given fraction of a color array into an existing color array. | |
| CRGB & | nblend (CRGB &existing, const CRGB &overlay, fract8 amountOfOverlay) |
| Destructively modifies one color, blending in a given fraction of an overlay color. | |
| void | nblend (CRGB *existing, const CRGB *overlay, uint16_t count, fract8 amountOfOverlay) |
| Destructively blends a given fraction of a color array into an existing color array. | |
| void | nblendPaletteTowardPalette (CRGBPalette16 ¤tPalette, CRGBPalette16 &targetPalette, uint8_t maxChanges=24) |
| Alter one palette by making it slightly more like a "target palette". | |
| void | nscale8 (CRGB *leds, uint16_t num_leds, uint8_t scale) |
| Scale the brightness of an array of pixels all at once. | |
| void | nscale8_video (CRGB *leds, uint16_t num_leds, uint8_t scale) |
| Scale the brightness of an array of pixels all at once. | |
| void | UpscalePalette (const class CHSVPalette16 &srcpal16, class CHSVPalette256 &destpal256) |
| Convert a 16-entry palette to a 256-entry palette. | |
| void | UpscalePalette (const class CHSVPalette16 &srcpal16, class CHSVPalette32 &destpal32) |
| Convert a 16-entry palette to a 32-entry palette. | |
| void | UpscalePalette (const class CHSVPalette32 &srcpal32, class CHSVPalette256 &destpal256) |
| Convert a 32-entry palette to a 256-entry palette. | |
| void | UpscalePalette (const class CRGBPalette16 &srcpal16, class CRGBPalette256 &destpal256) |
| Convert a 16-entry palette to a 256-entry palette. | |
| void | UpscalePalette (const class CRGBPalette16 &srcpal16, class CRGBPalette32 &destpal32) |
| Convert a 16-entry palette to a 32-entry palette. | |
| void | UpscalePalette (const class CRGBPalette32 &srcpal32, class CRGBPalette256 &destpal256) |
| Convert a 32-entry palette to a 256-entry palette. | |
Variables | |
| void const fl::XYMap &xymap | instead |
