Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- /*-------------------------------------------------------------------------
- RgbColor 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>
- struct HslColor;
- struct HsbColor;
- struct HtmlColor;
- // ------------------------------------------------------------------------
- // RgbColor represents a color object that is represented by Red, Green, Blue
- // component values. It contains helpful color routines to manipulate the
- // color.
- // ------------------------------------------------------------------------
- struct RgbColor
- {
- // ------------------------------------------------------------------------
- // Construct a RgbColor using R, G, B values (0-255)
- // ------------------------------------------------------------------------
- RgbColor(uint8_t r, uint8_t g, uint8_t b) :
- R(r), G(g), B(b)
- {
- };
- // ------------------------------------------------------------------------
- // Construct a RgbColor using a single brightness value (0-255)
- // This works well for creating gray tone colors
- // (0) = black, (255) = white, (128) = gray
- // ------------------------------------------------------------------------
- RgbColor(uint8_t brightness) :
- R(brightness), G(brightness), B(brightness)
- {
- };
- // ------------------------------------------------------------------------
- // Construct a RgbColor using HtmlColor
- // ------------------------------------------------------------------------
- RgbColor(const HtmlColor& color);
- // ------------------------------------------------------------------------
- // Construct a RgbColor using HslColor
- // ------------------------------------------------------------------------
- RgbColor(const HslColor& color);
- // ------------------------------------------------------------------------
- // Construct a RgbColor using HsbColor
- // ------------------------------------------------------------------------
- RgbColor(const HsbColor& color);
- // ------------------------------------------------------------------------
- // Construct a RgbColor that will have its values set in latter operations
- // CAUTION: The R,G,B members are not initialized and may not be consistent
- // ------------------------------------------------------------------------
- RgbColor()
- {
- };
- // ------------------------------------------------------------------------
- // Comparison operators
- // ------------------------------------------------------------------------
- bool operator==(const RgbColor& other) const
- {
- return (R == other.R && G == other.G && B == other.B);
- };
- bool operator!=(const RgbColor& other) const
- {
- return !(*this == other);
- };
- // ------------------------------------------------------------------------
- // CalculateBrightness will calculate the overall brightness
- // NOTE: This is a simple linear brightness
- // ------------------------------------------------------------------------
- uint8_t CalculateBrightness() const;
- // ------------------------------------------------------------------------
- // Darken will adjust the color by the given delta toward black
- // NOTE: This is a simple linear change
- // delta - (0-255) the amount to dim the color
- // ------------------------------------------------------------------------
- void Darken(uint8_t delta);
- // ------------------------------------------------------------------------
- // Lighten will adjust the color by the given delta toward white
- // NOTE: This is a simple linear change
- // delta - (0-255) the amount to lighten the color
- // ------------------------------------------------------------------------
- void Lighten(uint8_t delta);
- // ------------------------------------------------------------------------
- // 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 will return left and 1.0 will return right
- // and a value between will blend the color weighted linearly between them
- // ------------------------------------------------------------------------
- static RgbColor LinearBlend(const RgbColor& left, const RgbColor& right, float progress);
- // ------------------------------------------------------------------------
- // BilinearBlend between four colors by the amount defined by 2d variable
- // c00 - upper left quadrant color
- // c01 - upper right quadrant color
- // c10 - lower left quadrant color
- // c11 - lower right quadrant color
- // x - unit value (0.0 - 1.0) that defines the blend progress in horizontal space
- // y - unit value (0.0 - 1.0) that defines the blend progress in vertical space
- // ------------------------------------------------------------------------
- static RgbColor BilinearBlend(const RgbColor& c00,
- const RgbColor& c01,
- const RgbColor& c10,
- const RgbColor& c11,
- float x,
- float y);
- // ------------------------------------------------------------------------
- // Red, Green, Blue color members (0-255) where
- // (0,0,0) is black and (255,255,255) is white
- // ------------------------------------------------------------------------
- uint8_t R;
- uint8_t G;
- uint8_t B;
- };
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement