juce_Colour.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission is granted to use this software under the terms of either:
   a) the GPL v2 (or any later version)
   b) the Affero GPL v3
 
   Details of these licenses can be found at: www.gnu.org/licenses
 
   JUCE 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 General Public License for more details.
 
   ------------------------------------------------------------------------------
 
   To release a closed-source product which uses JUCE, commercial licenses are
   available: visit www.juce.com for more information.
 
  ==============================================================================
*/
 
#ifndef JUCE_COLOUR_H_INCLUDED
#define JUCE_COLOUR_H_INCLUDED
 
 
//==============================================================================
class JUCE_API  Colour
{
public:
    //==============================================================================
    Colour() noexcept;
 
    Colour (const Colour& other) noexcept;
 
    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;
 
    Colour (PixelARGB argb) noexcept;
 
    Colour (PixelRGB rgb) noexcept;
 
    Colour (PixelAlpha alpha) noexcept;
 
    static Colour fromHSV (float hue,
                           float saturation,
                           float brightness,
                           float alpha) noexcept;
 
    ~Colour() noexcept;
 
    Colour& operator= (const Colour& other) noexcept;
 
    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 getBrightness() const noexcept;
 
    float getPerceivedBrightness() const noexcept;
 
    void getHSB (float& hue,
                 float& saturation,
                 float& brightness) const noexcept;
 
    //==============================================================================
    Colour withHue (float newHue) const noexcept;
 
    Colour withSaturation (float newSaturation) const noexcept;
 
    Colour withBrightness (float newBrightness) const noexcept;
 
    Colour withRotatedHue (float amountToRotate) const noexcept;
 
    Colour withMultipliedSaturation (float multiplier) const noexcept;
 
    Colour withMultipliedBrightness (float amount) const noexcept;
 
    //==============================================================================
    Colour brighter (float amountBrighter = 0.4f) const noexcept;
 
    Colour darker (float amountDarker = 0.4f) const noexcept;
 
    //==============================================================================
    Colour contrasting (float amount = 1.0f) const noexcept;
 
    Colour contrasting (Colour targetColour, float minLuminosityDiff) const noexcept;
 
    static Colour contrasting (Colour colour1,
                               Colour colour2) noexcept;
 
    //==============================================================================
    static Colour greyLevel (float brightness) noexcept;
 
    //==============================================================================
    String toString() const;
 
    static Colour fromString (StringRef encodedColourString);
 
    String toDisplayString (bool includeAlphaValue) const;
 
private:
    //==============================================================================
    PixelARGB argb;
};
 
 
#endif   // JUCE_COLOUR_H_INCLUDED