Represents a colour, also including a transparency value. More...
#include <juce_Colour.h>
Public Member Functions | |
Colour ()=default | |
Creates a transparent black colour. More... | |
Colour (const Colour &)=default | |
Creates a copy of another Colour object. More... | |
Colour (float hue, float saturation, float brightness, float alpha) noexcept | |
Creates a colour using floating point hue, saturation, brightness and alpha values. More... | |
Colour (float hue, float saturation, float brightness, uint8 alpha) noexcept | |
Creates a colour using floating point hue, saturation and brightness values, and an 8-bit alpha. More... | |
Colour (PixelAlpha alpha) noexcept | |
Creates a colour using a PixelAlpha object. More... | |
Colour (PixelARGB argb) noexcept | |
Creates a colour using a PixelARGB object. More... | |
Colour (PixelRGB rgb) noexcept | |
Creates a colour using a PixelRGB object. More... | |
Colour (uint32 argb) noexcept | |
Creates a colour from a 32-bit ARGB value. More... | |
Colour (uint8 red, uint8 green, uint8 blue) noexcept | |
Creates an opaque colour using 8-bit red, green and blue values. More... | |
Colour (uint8 red, uint8 green, uint8 blue, float alpha) noexcept | |
Creates a colour from 8-bit red, green, and blue values, and a floating-point alpha. More... | |
Colour (uint8 red, uint8 green, uint8 blue, uint8 alpha) noexcept | |
Creates a colour using 8-bit red, green, blue and alpha values. More... | |
~Colour ()=default | |
Destructor. More... | |
JUCE_NODISCARD Colour | brighter (float amountBrighter=0.4f) const noexcept |
Returns a brighter version of this colour. More... | |
JUCE_NODISCARD Colour | contrasting (Colour targetColour, float minLuminosityDiff) const noexcept |
Returns a colour that is as close as possible to a target colour whilst still being in contrast to this one. More... | |
JUCE_NODISCARD Colour | contrasting (float amount=1.0f) const noexcept |
Returns a colour that will be clearly visible against this colour. More... | |
JUCE_NODISCARD Colour | darker (float amountDarker=0.4f) const noexcept |
Returns a darker version of this colour. More... | |
uint8 | getAlpha () const noexcept |
Returns the colour's alpha (opacity). More... | |
uint32 | getARGB () const noexcept |
Returns a 32-bit integer that represents this colour. More... | |
uint8 | getBlue () const noexcept |
Returns the blue component of this colour. More... | |
float | getBrightness () const noexcept |
Returns the colour's brightness component. More... | |
float | getFloatAlpha () const noexcept |
Returns the colour's alpha (opacity) as a floating point value. More... | |
float | getFloatBlue () const noexcept |
Returns the blue component of this colour as a floating point value. More... | |
float | getFloatGreen () const noexcept |
Returns the green component of this colour as a floating point value. More... | |
float | getFloatRed () const noexcept |
Returns the red component of this colour as a floating point value. More... | |
uint8 | getGreen () const noexcept |
Returns the green component of this colour. More... | |
void | getHSB (float &hue, float &saturation, float &brightness) const noexcept |
Returns the colour's hue, saturation and brightness components all at once. More... | |
void | getHSL (float &hue, float &saturation, float &lightness) const noexcept |
Returns the colour's hue, saturation and lightness components all at once. More... | |
float | getHue () const noexcept |
Returns the colour's hue component. More... | |
float | getLightness () const noexcept |
Returns the colour's lightness component. More... | |
float | getPerceivedBrightness () const noexcept |
Returns a skewed brightness value, adjusted to better reflect the way the human eye responds to different colour channels. More... | |
const PixelARGB | getPixelARGB () const noexcept |
Returns a premultiplied ARGB pixel object that represents this colour. More... | |
uint8 | getRed () const noexcept |
Returns the red component of this colour. More... | |
float | getSaturation () const noexcept |
Returns the colour's saturation component. More... | |
float | getSaturationHSL () const noexcept |
Returns the colour's saturation component as represented in the HSL colour space. More... | |
Colour | interpolatedWith (Colour other, float proportionOfOther) const noexcept |
Returns a colour that lies somewhere between this one and another. More... | |
bool | isOpaque () const noexcept |
Returns true if this colour is completely opaque. More... | |
bool | isTransparent () const noexcept |
Returns true if this colour is completely transparent. More... | |
bool | operator!= (const Colour &other) const noexcept |
Compares two colours. More... | |
Colour & | operator= (const Colour &)=default |
Copies another Colour object. More... | |
bool | operator== (const Colour &other) const noexcept |
Compares two colours. More... | |
Colour | overlaidWith (Colour foregroundColour) const noexcept |
Returns a colour that is the result of alpha-compositing a new colour over this one. More... | |
String | toDisplayString (bool includeAlphaValue) const |
Returns the colour as a hex string in the form RRGGBB or AARRGGBB. More... | |
String | toString () const |
Returns a stringified version of this colour. More... | |
Colour | withAlpha (float newAlpha) const noexcept |
Returns a colour that's the same colour as this one, but with a new alpha value. More... | |
Colour | withAlpha (uint8 newAlpha) const noexcept |
Returns a colour that's the same colour as this one, but with a new alpha value. More... | |
JUCE_NODISCARD Colour | withBrightness (float newBrightness) const noexcept |
Returns a copy of this colour with a different brightness. More... | |
JUCE_NODISCARD Colour | withHue (float newHue) const noexcept |
Returns a copy of this colour with a different hue. More... | |
JUCE_NODISCARD Colour | withLightness (float newLightness) const noexcept |
Returns a copy of this colour with a different lightness. More... | |
Colour | withMultipliedAlpha (float alphaMultiplier) const noexcept |
Returns a colour that's the same colour as this one, but with a modified alpha value. More... | |
JUCE_NODISCARD Colour | withMultipliedBrightness (float amount) const noexcept |
Returns a copy of this colour with its brightness multiplied by the given value. More... | |
JUCE_NODISCARD Colour | withMultipliedLightness (float amount) const noexcept |
Returns a copy of this colour with its lightness multiplied by the given value. More... | |
JUCE_NODISCARD Colour | withMultipliedSaturation (float multiplier) const noexcept |
Returns a copy of this colour with its saturation multiplied by the given value. More... | |
JUCE_NODISCARD Colour | withMultipliedSaturationHSL (float multiplier) const noexcept |
Returns a copy of this colour with its saturation multiplied by the given value. More... | |
JUCE_NODISCARD Colour | withRotatedHue (float amountToRotate) const noexcept |
Returns a copy of this colour with its hue rotated. More... | |
JUCE_NODISCARD Colour | withSaturation (float newSaturation) const noexcept |
Returns a copy of this colour with a different saturation. More... | |
JUCE_NODISCARD Colour | withSaturationHSL (float newSaturation) const noexcept |
Returns a copy of this colour with a different saturation in the HSL colour space. More... | |
Static Public Member Functions | |
static JUCE_NODISCARD Colour | contrasting (Colour colour1, Colour colour2) noexcept |
Returns a colour that contrasts against two colours. More... | |
static Colour | fromFloatRGBA (float red, float green, float blue, float alpha) noexcept |
Creates a colour using floating point red, green, blue and alpha values. More... | |
static Colour | fromHSL (float hue, float saturation, float lightness, float alpha) noexcept |
Creates a colour using floating point hue, saturation, lightness and alpha values. More... | |
static Colour | fromHSV (float hue, float saturation, float brightness, float alpha) noexcept |
Creates a colour using floating point hue, saturation, brightness and alpha values. More... | |
static Colour | fromRGB (uint8 red, uint8 green, uint8 blue) noexcept |
Creates an opaque colour using 8-bit red, green and blue values. More... | |
static Colour | fromRGBA (uint8 red, uint8 green, uint8 blue, uint8 alpha) noexcept |
Creates a colour using 8-bit red, green, blue and alpha values. More... | |
static JUCE_NODISCARD Colour | fromString (StringRef encodedColourString) |
Reads the colour from a string that was created with toString(). More... | |
static JUCE_NODISCARD Colour | greyLevel (float brightness) noexcept |
Returns an opaque shade of grey. More... | |
Private Attributes | |
PixelARGB | argb { 0, 0, 0, 0 } |
Represents a colour, also including a transparency value.
The colour is stored internally as unsigned 8-bit red, green, blue and alpha values.
@tags{Graphics}
|
default |
Creates a transparent black colour.
|
explicitnoexcept |
Creates a colour from a 32-bit ARGB value.
The format of this number is: ((alpha << 24) | (red << 16) | (green << 8) | blue).
All components in the range 0x00 to 0xff. An alpha of 0x00 is completely transparent, alpha of 0xff is opaque.
Creates an opaque colour using 8-bit red, green and blue values.
Creates a colour using 8-bit red, green, blue and alpha values.
Creates a colour from 8-bit red, green, and blue values, and a floating-point alpha.
Alpha of 0.0 is transparent, alpha of 1.0f is opaque. Values outside the valid range will be clipped.
Creates a colour using floating point hue, saturation and brightness values, and an 8-bit alpha.
The floating point values must be between 0.0 and 1.0. An alpha of 0x00 is completely transparent, alpha of 0xff is opaque. Values outside the valid range will be clipped.
Creates a colour using floating point hue, saturation, brightness and alpha values.
All values must be between 0.0 and 1.0. Numbers outside the valid range will be clipped.
|
noexcept |
Creates a colour using a PixelARGB object.
This function assumes that the argb pixel is not premultiplied.
|
noexcept |
Creates a colour using a PixelAlpha object.
|
default |
Destructor.
|
noexcept |
Returns a brighter version of this colour.
amountBrighter | how much brighter to make it - a value greater than or equal to 0, where 0 is unchanged, and higher values make it brighter |
|
staticnoexcept |
Returns a colour that contrasts against two colours.
Looks for a colour that contrasts with both of the colours passed-in. Handy for things like choosing a highlight colour in text editors, etc.
|
noexcept |
Returns a colour that is as close as possible to a target colour whilst still being in contrast to this one.
The colour that is returned will be the targetColour, but with its luminosity nudged up or down so that it differs from the luminosity of this colour by at least the amount specified by minLuminosityDiff.
|
noexcept |
Returns a colour that will be clearly visible against this colour.
The amount parameter indicates how contrasting the new colour should be, so e.g. Colours::black.contrasting (0.1f) will return a colour that's just a little bit lighter; Colours::black.contrasting (1.0f) will return white; Colours::white.contrasting (1.0f) will return black, etc.
|
noexcept |
Returns a darker version of this colour.
amountDarker | how much darker to make it - a value greater than or equal to 0, where 0 is unchanged, and higher values make it darker |
|
staticnoexcept |
Creates a colour using floating point red, green, blue and alpha values.
Numbers outside the range 0..1 will be clipped.
|
staticnoexcept |
Creates a colour using floating point hue, saturation, lightness and alpha values.
All values must be between 0.0 and 1.0. Numbers outside the valid range will be clipped.
|
staticnoexcept |
Creates a colour using floating point hue, saturation, brightness and alpha values.
All values must be between 0.0 and 1.0. Numbers outside the valid range will be clipped.
Creates an opaque colour using 8-bit red, green and blue values.
|
staticnoexcept |
Creates a colour using 8-bit red, green, blue and alpha values.
|
static |
Reads the colour from a string that was created with toString().
|
inlinenoexcept |
Returns the colour's alpha (opacity).
Alpha of 0x00 is completely transparent, 0xff is completely opaque.
References juce::PixelARGB::getAlpha().
|
noexcept |
Returns a 32-bit integer that represents this colour.
The format of this number is: ((alpha << 24) | (red << 16) | (green << 8) | blue).
|
inlinenoexcept |
Returns the blue component of this colour.
References juce::PixelARGB::getBlue().
|
noexcept |
Returns the colour's brightness component.
The value returned is in the range 0.0 to 1.0
|
noexcept |
Returns the colour's alpha (opacity) as a floating point value.
Alpha of 0.0 is completely transparent, 1.0 is completely opaque.
Referenced by juce::FillType::getOpacity().
|
noexcept |
Returns the blue component of this colour as a floating point value.
|
noexcept |
Returns the green component of this colour as a floating point value.
|
noexcept |
Returns the red component of this colour as a floating point value.
|
inlinenoexcept |
Returns the green component of this colour.
References juce::PixelARGB::getGreen().
Returns the colour's hue, saturation and brightness components all at once.
The values returned are in the range 0.0 to 1.0
Returns the colour's hue, saturation and lightness components all at once.
The values returned are in the range 0.0 to 1.0
|
noexcept |
Returns the colour's hue component.
The value returned is in the range 0.0 to 1.0
|
noexcept |
Returns the colour's lightness component.
The value returned is in the range 0.0 to 1.0
|
noexcept |
Returns a skewed brightness value, adjusted to better reflect the way the human eye responds to different colour channels.
This makes it better than getBrightness() for comparing differences in brightness.
|
noexcept |
Returns a premultiplied ARGB pixel object that represents this colour.
|
inlinenoexcept |
Returns the red component of this colour.
References juce::PixelARGB::getRed().
|
noexcept |
Returns the colour's saturation component.
The value returned is in the range 0.0 to 1.0
|
noexcept |
Returns the colour's saturation component as represented in the HSL colour space.
The value returned is in the range 0.0 to 1.0
|
staticnoexcept |
Returns an opaque shade of grey.
brightness | the level of grey to return - 0 is black, 1.0 is white |
Returns a colour that lies somewhere between this one and another.
If amountOfOther is zero, the result is 100% this colour, if amountOfOther is 1.0, the result is 100% of the other colour.
|
noexcept |
Returns true if this colour is completely opaque.
Equivalent to (getAlpha() == 0xff).
Referenced by juce::WebView2Preferences::withBackgroundColour().
|
noexcept |
Returns true if this colour is completely transparent.
Equivalent to (getAlpha() == 0x00).
Referenced by juce::WebView2Preferences::withBackgroundColour().
Returns a colour that is the result of alpha-compositing a new colour over this one.
If the foreground colour is semi-transparent, it is blended onto this colour accordingly.
Returns the colour as a hex string in the form RRGGBB or AARRGGBB.
String juce::Colour::toString | ( | ) | const |
Returns a stringified version of this colour.
The string can be turned back into a colour using the fromString() method.
Returns a colour that's the same colour as this one, but with a new alpha value.
Returns a colour that's the same colour as this one, but with a new alpha value.
|
noexcept |
Returns a copy of this colour with a different brightness.
|
noexcept |
Returns a copy of this colour with a different hue.
|
noexcept |
Returns a copy of this colour with a different lightness.
Returns a colour that's the same colour as this one, but with a modified alpha value.
The new colour's alpha will be this object's alpha multiplied by the value passed-in.
|
noexcept |
Returns a copy of this colour with its brightness multiplied by the given value.
The new colour's brightness is (this->getBrightness() * multiplier) (the result is clipped to legal limits).
|
noexcept |
Returns a copy of this colour with its lightness multiplied by the given value.
The new colour's lightness is (this->lightness() * multiplier) (the result is clipped to legal limits).
|
noexcept |
Returns a copy of this colour with its saturation multiplied by the given value.
The new colour's saturation is (this->getSaturation() * multiplier) (the result is clipped to legal limits).
|
noexcept |
Returns a copy of this colour with its saturation multiplied by the given value.
The new colour's saturation is (this->getSaturation() * multiplier) (the result is clipped to legal limits).
This will be in the HSL colour space.
|
noexcept |
Returns a copy of this colour with its hue rotated.
The new colour's hue is ((this->getHue() + amountToRotate) % 1.0)
|
noexcept |
Returns a copy of this colour with a different saturation.
|
noexcept |
Returns a copy of this colour with a different saturation in the HSL colour space.
|
private |