juce_Colour.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  Colour  final
{
public:
    //==============================================================================
    Colour() = default;

    Colour (const Colour&) = default;

    explicit Colour (uint32 argb) noexcept;

    Colour (uint8 red,
            uint8 green,
            uint8 blue) noexcept;

    static Colour fromRGB (uint8 red,
                           uint8 green,
                           uint8 blue) noexcept;

    Colour (uint8 red,
            uint8 green,
            uint8 blue,
            uint8 alpha) noexcept;

    static Colour fromRGBA (uint8 red,
                            uint8 green,
                            uint8 blue,
                            uint8 alpha) noexcept;

    Colour (uint8 red,
            uint8 green,
            uint8 blue,
            float alpha) noexcept;

    static Colour fromFloatRGBA (float red,
                                 float green,
                                 float blue,
                                 float alpha) noexcept;

    Colour (float hue,
            float saturation,
            float brightness,
            uint8 alpha) noexcept;

    Colour (float hue,
            float saturation,
            float brightness,
            float alpha) noexcept;

    static Colour fromHSV (float hue,
                           float saturation,
                           float brightness,
                           float alpha) noexcept;

    static Colour fromHSL (float hue,
                           float saturation,
                           float lightness,
                           float alpha) noexcept;

    Colour (PixelARGB argb) noexcept;

    Colour (PixelRGB rgb) noexcept;

    Colour (PixelAlpha alpha) noexcept;

    ~Colour() = default;

    Colour& operator= (const Colour&) = default;

    bool operator== (const Colour& other) const noexcept;
    bool operator!= (const Colour& other) const noexcept;
 
    //==============================================================================
    uint8 getRed() const noexcept                       { return argb.getRed(); }

    uint8 getGreen() const noexcept                     { return argb.getGreen(); }

    uint8 getBlue() const noexcept                      { return argb.getBlue(); }

    float getFloatRed() const noexcept;

    float getFloatGreen() const noexcept;

    float getFloatBlue() const noexcept;

    const PixelARGB getPixelARGB() const noexcept;

    uint32 getARGB() const noexcept;
 
    //==============================================================================
    uint8 getAlpha() const noexcept                     { return argb.getAlpha(); }

    float getFloatAlpha() const noexcept;

    bool isOpaque() const noexcept;

    bool isTransparent() const noexcept;

    Colour withAlpha (uint8 newAlpha) const noexcept;

    Colour withAlpha (float newAlpha) const noexcept;

    Colour withMultipliedAlpha (float alphaMultiplier) const noexcept;
 
    //==============================================================================
    Colour overlaidWith (Colour foregroundColour) const noexcept;

    Colour interpolatedWith (Colour other, float proportionOfOther) const noexcept;
 
    //==============================================================================
    float getHue() const noexcept;

    float getSaturation() const noexcept;

    float getSaturationHSL() const noexcept;

    float getBrightness() const noexcept;

    float getLightness() const noexcept;

    float getPerceivedBrightness() const noexcept;

    void getHSB (float& hue,
                 float& saturation,
                 float& brightness) const noexcept;

    void getHSL (float& hue,
                 float& saturation,
                 float& lightness) const noexcept;
 
    //==============================================================================
    JUCE_NODISCARD Colour withHue (float newHue) const noexcept;

    JUCE_NODISCARD Colour withSaturation (float newSaturation) const noexcept;

    JUCE_NODISCARD Colour withSaturationHSL (float newSaturation) const noexcept;

    JUCE_NODISCARD Colour withBrightness (float newBrightness) const noexcept;

    JUCE_NODISCARD Colour withLightness (float newLightness) const noexcept;

    JUCE_NODISCARD Colour withRotatedHue (float amountToRotate) const noexcept;

    JUCE_NODISCARD Colour withMultipliedSaturation (float multiplier) const noexcept;

    JUCE_NODISCARD Colour withMultipliedSaturationHSL (float multiplier) const noexcept;

    JUCE_NODISCARD Colour withMultipliedBrightness (float amount) const noexcept;

    JUCE_NODISCARD Colour withMultipliedLightness (float amount) const noexcept;
 
    //==============================================================================
    JUCE_NODISCARD Colour brighter (float amountBrighter = 0.4f) const noexcept;

    JUCE_NODISCARD Colour darker (float amountDarker = 0.4f) const noexcept;
 
    //==============================================================================
    JUCE_NODISCARD Colour contrasting (float amount = 1.0f) const noexcept;

    JUCE_NODISCARD Colour contrasting (Colour targetColour, float minLuminosityDiff) const noexcept;

    JUCE_NODISCARD static Colour contrasting (Colour colour1,
                                              Colour colour2) noexcept;
 
    //==============================================================================
    JUCE_NODISCARD static Colour greyLevel (float brightness) noexcept;
 
    //==============================================================================
    String toString() const;

    JUCE_NODISCARD static Colour fromString (StringRef encodedColourString);

    String toDisplayString (bool includeAlphaValue) const;
 
private:
    //==============================================================================
    PixelARGB argb { 0, 0, 0, 0 };
};
 
} // namespace juce