forked from Makuna/NeoPixelBus
76 lines
3.2 KiB
C
76 lines
3.2 KiB
C
|
/*-------------------------------------------------------------------------
|
||
|
|
HslColor provides a color object that can be directly consumed by NeoPixelBus
|
||
|
|
|
||
|
|
Written by Michael C. Miller.
|
||
|
|
|
||
|
|
I invest time and resources providing this open source code,
|
||
|
|
please support me by dontating (see https://github.com/Makuna/NeoPixelBus)
|
||
|
|
|
||
|
|
-------------------------------------------------------------------------
|
||
|
|
This file is part of the Makuna/NeoPixelBus library.
|
||
|
|
|
||
|
|
NeoPixelBus is free software: you can redistribute it and/or modify
|
||
|
|
it under the terms of the GNU Lesser General Public License as
|
||
|
|
published by the Free Software Foundation, either version 3 of
|
||
|
|
the License, or (at your option) any later version.
|
||
|
|
|
||
|
|
NeoPixelBus is distributed in the hope that it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU Lesser General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU Lesser General Public
|
||
|
|
License along with NeoPixel. If not, see
|
||
|
|
<http://www.gnu.org/licenses/>.
|
||
|
|
-------------------------------------------------------------------------*/
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#include <Arduino.h>
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// HslColor represents a color object that is represented by Hue, Saturation, Lightness
|
||
|
|
// component values. It contains helpful color routines to manipulate the
|
||
|
|
// color.
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
struct HslColor
|
||
|
|
{
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// Construct a HslColor using H, S, L values (0.0 - 1.0)
|
||
|
|
// L should be limited to between (0.0 - 0.5)
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
HslColor(float h, float s, float l) :
|
||
|
|
H(h), S(s), L(l)
|
||
|
|
{
|
||
|
|
};
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// Construct a HslColor using RgbColor
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
HslColor(RgbColor color);
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// Construct a HslColor that will have its values set in latter operations
|
||
|
|
// CAUTION: The H,S,L members are not initialized and may not be consistent
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
HslColor()
|
||
|
|
{
|
||
|
|
};
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// LinearBlend between two colors by the amount defined by progress variable
|
||
|
|
// left - the color to start the blend at
|
||
|
|
// right - the color to end the blend at
|
||
|
|
// progress - (0.0 - 1.0) value where 0.0 will return left and 1.0 will return right
|
||
|
|
// and a value between will blend the color weighted linearly between them
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
static HslColor LinearBlend(HslColor left, HslColor right, float progress);
|
||
|
|
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
// Hue, Saturation, Lightness color members
|
||
|
|
// ------------------------------------------------------------------------
|
||
|
|
float H;
|
||
|
|
float S;
|
||
|
|
float L;
|
||
|
|
};
|
||
|
|
|