Carla/source/modules/dgl/Color.hpp

/*
 * DISTRHO Plugin Framework (DPF)
 * Copyright (C) 2012-2025 Filipe Coelho <falktx@falktx.com>
 *
 * Permission to use, copy, modify, and/or distribute this software for any purpose with
 * or without fee is hereby granted, provided that the above copyright notice and this
 * permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
 * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef DGL_COLOR_HPP_INCLUDED
#define DGL_COLOR_HPP_INCLUDED

#include "Base.hpp"

struct NVGcolor;

START_NAMESPACE_DGL

// --------------------------------------------------------------------------------------------------------------------

/**
   A color made from red, green, blue and alpha floating-point values in [0..1] range.
*/
struct Color {
   /**
      Direct access to the color values.
    */
    union {
        float rgba[4];
        struct { float red, green, blue, alpha; };
    };

   /**
      Create solid black color.
    */
    Color() noexcept;

   /**
      Create a color from red, green, blue and alpha numeric values.
      All values except alpha must be in [0..255] range, with alpha in [0..1] range.
    */
    Color(int red, int green, int blue, float alpha = 1.0f) noexcept;

   /**
      Create a color from red, green, blue and alpha floating-point values.
      All values must in [0..1] range.
    */
    Color(float red, float green, float blue, float alpha = 1.0f) noexcept;

   /**
      Create a color by copying another color.
    */
    Color(const Color& color) noexcept;
    Color& operator=(const Color& color) noexcept;

   /**
      Create a color by linearly interpolating two other colors.
    */
    Color(const Color& color1, const Color& color2, float u) noexcept;

   /**
      Create a new color based on this one but with a different alpha value.
    */
    Color withAlpha(float alpha) const noexcept;

   /**
      Create a new color based on this one but with subtracted numeric value on all elements.
      Value must be in [0..255] range.
    */
    Color minus(int value) const noexcept;

   /**
      Create a new color based on this one but with subtracted floating-point value on all elements.
      Value must be in [0..1] range.
    */
    Color minus(float value) const noexcept;

   /**
      Create a new color based on this one but with added numeric value on all elements.
      Value must be in [0..255] range.
    */
    Color plus(int value) const noexcept;

   /**
      Create a new color based on this one but with added floating-point value on all elements.
      Value must be in [0..1] range.
    */
    Color plus(float value) const noexcept;

   /**
      Create a new color based on this one but colors inverted.
    */
    Color invert() const noexcept;

   /**
      Create a new color based on this one but in grayscale (using weighted average).
    */
    Color asGrayscale() const noexcept;

   /**
      Create a color specified by hue, saturation and lightness.
      Values must in [0..1] range.
    */
    static Color fromHSL(float hue, float saturation, float lightness, float alpha = 1.0f);

   /**
      Create a color from a HTML string like "#333" or "#112233".
    */
    static Color fromHTML(const char* rgb, float alpha = 1.0f) noexcept;

   /**
      Create a color from a RGB unsigned integer.
      Basically doing:
      ```
      uint8_t red   = (color >> 24) & 0xff;
      uint8_t green = (color >> 16) & 0xff;
      uint8_t blue  = (color >>  8) & 0xff;
      ```
    */
    static Color fromRGB(uint color, float alpha = 1.0f) noexcept;

   /**
      Linearly interpolate this color against another.
    */
    void interpolate(const Color& other, float u) noexcept;

   /**
      Check if this color matches another.
      @note Comparison is done within 8-bit color space.
    */
    bool isEqual(const Color& color, bool withAlpha = true) noexcept;
    bool isNotEqual(const Color& color, bool withAlpha = true) noexcept;
    bool operator==(const Color& color) noexcept;
    bool operator!=(const Color& color) noexcept;

   /**
      Fix color bounds if needed.
    */
    void fixBounds() noexcept;

   /**
      Set this color for use in the next drawing operation for the provided context.
    */
    void setFor(const GraphicsContext& context, bool includeAlpha = false);

   /**
      @internal
      Needed for NanoVG compatibility.
    */
    Color(const NVGcolor&) noexcept;
    operator NVGcolor() const noexcept;
};

// --------------------------------------------------------------------------------------------------------------------

END_NAMESPACE_DGL

#endif // DGL_COLOR_HPP_INCLUDED