openshot-audio  0.1.7
Public Member Functions | Static Public Member Functions | List of all members
juce::Colour Class Reference

#include <juce_graphics.h>

Public Member Functions

 Colour () noexcept
 
 Colour (const Colour &other) noexcept
 
 Colour (uint32 argb) noexcept
 
 Colour (uint8 red, uint8 green, uint8 blue) noexcept
 
 Colour (uint8 red, uint8 green, uint8 blue, uint8 alpha) noexcept
 
 Colour (uint8 red, uint8 green, uint8 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
 
 ~Colour () noexcept
 
Colouroperator= (const Colour &other) noexcept
 
bool operator== (const Colour &other) const noexcept
 
bool operator!= (const Colour &other) const noexcept
 
uint8 getRed () const noexcept
 
uint8 getGreen () const noexcept
 
uint8 getBlue () const noexcept
 
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
 
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
 
String toString () const
 
String toDisplayString (bool includeAlphaValue) const
 

Static Public Member Functions

static Colour fromRGB (uint8 red, uint8 green, uint8 blue) noexcept
 
static Colour fromRGBA (uint8 red, uint8 green, uint8 blue, uint8 alpha) noexcept
 
static Colour fromFloatRGBA (float red, float green, float blue, float alpha) noexcept
 
static Colour fromHSV (float hue, float saturation, float brightness, float alpha) noexcept
 
static Colour contrasting (Colour colour1, Colour colour2) noexcept
 
static Colour greyLevel (float brightness) noexcept
 
static Colour fromString (StringRef encodedColourString)
 

Detailed Description

Represents a colour, also including a transparency value.

The colour is stored internally as unsigned 8-bit red, green, blue and alpha values.

Constructor & Destructor Documentation

Colour::Colour ( )
noexcept

Creates a transparent black colour.

Colour::Colour ( const Colour other)
noexcept

Creates a copy of another Colour object.

Colour::Colour ( uint32  argb)
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.

See Also
getPixelARGB
Colour::Colour ( uint8  red,
uint8  green,
uint8  blue 
)
noexcept

Creates an opaque colour using 8-bit red, green and blue values

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

Creates a colour using 8-bit red, green, blue and alpha values.

Colour::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.

Alpha of 0.0 is transparent, alpha of 1.0f is opaque. Values outside the valid range will be clipped.

Colour::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.

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.

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

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.

Colour::Colour ( PixelARGB  argb)
noexcept

Creates a colour using a PixelARGB object. This function assumes that the argb pixel is not premultiplied.

Colour::Colour ( PixelRGB  rgb)
noexcept

Creates a colour using a PixelRGB object.

Colour::Colour ( PixelAlpha  alpha)
noexcept

Creates a colour using a PixelAlpha object.

Colour::~Colour ( )
noexcept

Destructor.

Member Function Documentation

Colour Colour::brighter ( float  amountBrighter = 0.4f) const
noexcept

Returns a brighter version of this colour.

Parameters
amountBrighterhow much brighter to make it - a value from 0 to 1.0 where 0 is unchanged, and higher values make it brighter
See Also
withMultipliedBrightness
Colour Colour::contrasting ( float  amount = 1.0f) const
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.

Colour 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.

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.

Colour Colour::contrasting ( Colour  colour1,
Colour  colour2 
)
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.

Colour Colour::darker ( float  amountDarker = 0.4f) const
noexcept

Returns a darker version of this colour.

Parameters
amountDarkerhow much darker to make it - a value from 0 to 1.0 where 0 is unchanged, and higher values make it darker
See Also
withMultipliedBrightness
Colour Colour::fromFloatRGBA ( float  red,
float  green,
float  blue,
float  alpha 
)
staticnoexcept

Creates a colour using floating point red, green, blue and alpha values. Numbers outside the range 0..1 will be clipped.

Colour Colour::fromHSV ( float  hue,
float  saturation,
float  brightness,
float  alpha 
)
staticnoexcept

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.

Colour Colour::fromRGB ( uint8  red,
uint8  green,
uint8  blue 
)
staticnoexcept

Creates an opaque colour using 8-bit red, green and blue values

Colour Colour::fromRGBA ( uint8  red,
uint8  green,
uint8  blue,
uint8  alpha 
)
staticnoexcept

Creates a colour using 8-bit red, green, blue and alpha values.

Colour Colour::fromString ( StringRef  encodedColourString)
static

Reads the colour from a string that was created with toString().

uint8 juce::Colour::getAlpha ( ) const
inlinenoexcept

Returns the colour's alpha (opacity).

Alpha of 0x00 is completely transparent, 0xff is completely opaque.

uint32 Colour::getARGB ( ) const
noexcept

Returns a 32-bit integer that represents this colour.

The format of this number is: ((alpha << 24) | (red << 16) | (green << 16) | blue).

uint8 juce::Colour::getBlue ( ) const
inlinenoexcept

Returns the blue component of this colour.

Returns
a value between 0x00 and 0xff.
float Colour::getBrightness ( ) const
noexcept

Returns the colour's brightness component. The value returned is in the range 0.0 to 1.0

float Colour::getFloatAlpha ( ) const
noexcept

Returns the colour's alpha (opacity) as a floating point value.

Alpha of 0.0 is completely transparent, 1.0 is completely opaque.

float Colour::getFloatBlue ( ) const
noexcept

Returns the blue component of this colour as a floating point value.

Returns
a value between 0.0 and 1.0
float Colour::getFloatGreen ( ) const
noexcept

Returns the green component of this colour as a floating point value.

Returns
a value between 0.0 and 1.0
float Colour::getFloatRed ( ) const
noexcept

Returns the red component of this colour as a floating point value.

Returns
a value between 0.0 and 1.0
uint8 juce::Colour::getGreen ( ) const
inlinenoexcept

Returns the green component of this colour.

Returns
a value between 0x00 and 0xff.
void Colour::getHSB ( float &  hue,
float &  saturation,
float &  brightness 
) const
noexcept

Returns the colour's hue, saturation and brightness components all at once. The values returned are in the range 0.0 to 1.0

float Colour::getHue ( ) const
noexcept

Returns the colour's hue component. The value returned is in the range 0.0 to 1.0

float Colour::getPerceivedBrightness ( ) const
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.

const PixelARGB Colour::getPixelARGB ( ) const
noexcept

Returns a premultiplied ARGB pixel object that represents this colour.

uint8 juce::Colour::getRed ( ) const
inlinenoexcept

Returns the red component of this colour.

Returns
a value between 0x00 and 0xff.
float Colour::getSaturation ( ) const
noexcept

Returns the colour's saturation component. The value returned is in the range 0.0 to 1.0

Colour Colour::greyLevel ( float  brightness)
staticnoexcept

Returns an opaque shade of grey.

Parameters
brightnessthe level of grey to return - 0 is black, 1.0 is white
Colour Colour::interpolatedWith ( Colour  other,
float  proportionOfOther 
) const
noexcept

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.

bool Colour::isOpaque ( ) const
noexcept

Returns true if this colour is completely opaque.

Equivalent to (getAlpha() == 0xff).

bool Colour::isTransparent ( ) const
noexcept

Returns true if this colour is completely transparent.

Equivalent to (getAlpha() == 0x00).

bool Colour::operator!= ( const Colour other) const
noexcept

Compares two colours.

Colour & Colour::operator= ( const Colour other)
noexcept

Copies another Colour object.

bool Colour::operator== ( const Colour other) const
noexcept

Compares two colours.

Colour Colour::overlaidWith ( Colour  foregroundColour) const
noexcept

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.

String Colour::toDisplayString ( bool  includeAlphaValue) const

Returns the colour as a hex string in the form RRGGBB or AARRGGBB.

String Colour::toString ( ) const

Returns a stringified version of this colour. The string can be turned back into a colour using the fromString() method.

Colour Colour::withAlpha ( uint8  newAlpha) const
noexcept

Returns a colour that's the same colour as this one, but with a new alpha value.

Colour Colour::withAlpha ( float  newAlpha) const
noexcept

Returns a colour that's the same colour as this one, but with a new alpha value.

Colour Colour::withBrightness ( float  newBrightness) const
noexcept

Returns a copy of this colour with a different brightness.

See Also
brighter, darker, withMultipliedBrightness
Colour Colour::withHue ( float  newHue) const
noexcept

Returns a copy of this colour with a different hue.

Colour Colour::withMultipliedAlpha ( float  alphaMultiplier) const
noexcept

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.

Colour Colour::withMultipliedBrightness ( float  amount) const
noexcept

Returns a copy of this colour with its brightness multiplied by the given value.

The new colour's saturation is (this->getBrightness() * multiplier) (the result is clipped to legal limits).

Colour Colour::withMultipliedSaturation ( float  multiplier) const
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).

Colour Colour::withRotatedHue ( float  amountToRotate) const
noexcept

Returns a copy of this colour with it hue rotated.

The new colour's hue is ((this->getHue() + amountToRotate) % 1.0)

See Also
brighter, darker, withMultipliedBrightness
Colour Colour::withSaturation ( float  newSaturation) const
noexcept

Returns a copy of this colour with a different saturation.


The documentation for this class was generated from the following files: