Inheritance diagram for Exponent::GUI::Basics::CAlphaColour:
Definition at line 36 of file CAlphaColour.hpp.
Exponent::GUI::Basics::CAlphaColour::CAlphaColour | ( | const unsigned long | red, | |
const unsigned long | green, | |||
const unsigned long | blue, | |||
const unsigned long | alpha = 255 | |||
) |
Construction
red | The red component | |
green | The green component | |
blue | The blue component | |
alpha | The alpha component |
Exponent::GUI::Basics::CAlphaColour::CAlphaColour | ( | ) |
Construction
Exponent::GUI::Basics::CAlphaColour::CAlphaColour | ( | const CAlphaColour & | colour | ) |
Copy construction
colour | The colour to copy |
virtual Exponent::GUI::Basics::CAlphaColour::~CAlphaColour | ( | ) | [virtual] |
Destruction
static FORCEINLINE void Exponent::GUI::Basics::CAlphaColour::alphaBlend | ( | CColour & | destination, | |
const CColour & | background, | |||
const CColour & | source, | |||
const unsigned long | alpha | |||
) | [inline, static] |
Alpha blend two colours with a fixed alpha
destination | The destination colour, on return this is filled with the alpha blended colour | |
background | The background colour | |
source | The top level colour | |
alpha | The alpha level to process with |
Definition at line 180 of file CAlphaColour.hpp.
References alphaComposite(), Exponent::GUI::Basics::CColour::getBlue(), Exponent::GUI::Basics::CColour::getGreen(), Exponent::GUI::Basics::CColour::getRed(), Exponent::GUI::Basics::CColour::setBlue(), Exponent::GUI::Basics::CColour::setGreen(), and Exponent::GUI::Basics::CColour::setRed().
static FORCEINLINE void Exponent::GUI::Basics::CAlphaColour::alphaBlend | ( | CColour & | destination, | |
const CAlphaColour & | background, | |||
const CAlphaColour & | source | |||
) | [inline, static] |
Alpha blend two colours
destination | The destination colour, on return this is filled with the alpha blended colour | |
background | The background colour | |
source | The top level colour |
Definition at line 166 of file CAlphaColour.hpp.
References alphaComposite(), getAlpha(), Exponent::GUI::Basics::CColour::getBlue(), Exponent::GUI::Basics::CColour::getGreen(), Exponent::GUI::Basics::CColour::getRed(), Exponent::GUI::Basics::CColour::setBlue(), Exponent::GUI::Basics::CColour::setGreen(), and Exponent::GUI::Basics::CColour::setRed().
static FORCEINLINE unsigned long Exponent::GUI::Basics::CAlphaColour::alphaComposite | ( | const unsigned long | foreground, | |
const unsigned long | background, | |||
const unsigned long | alpha | |||
) | [inline, static, protected] |
Alpha composite a single value
foreground | The front colour | |
background | The background colour | |
alpha | The alpha value |
Definition at line 208 of file CAlphaColour.hpp.
Referenced by alphaBlend().
void Exponent::GUI::Basics::CAlphaColour::darkenColour | ( | ) |
Darken the colour
unsigned long Exponent::GUI::Basics::CAlphaColour::getAlpha | ( | ) | const [inline] |
Get the alpha value
unsigned | long The alpha value |
Definition at line 121 of file CAlphaColour.hpp.
References m_alpha.
Referenced by alphaBlend().
void Exponent::GUI::Basics::CAlphaColour::getAsColour | ( | CColour & | colour | ) | const |
Get as a colour
colour | On return this is filled with the colour |
CColour* Exponent::GUI::Basics::CAlphaColour::getAsColour | ( | ) | const |
Get as a colour
CColour* | The colour, you must dispose |
virtual void Exponent::GUI::Basics::CAlphaColour::getObjectDescription | ( | char * | string, | |
const long | size | |||
) | const [virtual] |
Get a description of the object
string | On return is filled with the description | |
size | The size of the stirng |
Reimplemented from Exponent::GUI::Basics::CColour.
void Exponent::GUI::Basics::CAlphaColour::lightenColour | ( | ) |
Lighten the colour
CAlphaColour& Exponent::GUI::Basics::CAlphaColour::operator= | ( | const CColour & | colour | ) |
Assignment operator
colour | The colour to copy with alpha 255 |
Reimplemented from Exponent::GUI::Basics::CColour.
CAlphaColour& Exponent::GUI::Basics::CAlphaColour::operator= | ( | const CAlphaColour & | colour | ) |
Assignment operator
colour | The colour to copy |
bool Exponent::GUI::Basics::CAlphaColour::operator== | ( | const CAlphaColour & | colour | ) | const |
Equality operator
colour | The colour to compare to |
bool | True if colours are the same, false otherwise |
void Exponent::GUI::Basics::CAlphaColour::setAlpha | ( | const unsigned long | alpha | ) | [inline] |
Set the alpha value
alpha | The alpha component |
Definition at line 115 of file CAlphaColour.hpp.
References m_alpha.
virtual void Exponent::GUI::Basics::CAlphaColour::setColour | ( | const unsigned long | red, | |
const unsigned long | green, | |||
const unsigned long | blue, | |||
const unsigned long | alpha | |||
) | [virtual] |
Set all the values
red | The red component | |
green | The green component | |
blue | The blue component | |
alpha | The alpha component |
Black
Definition at line 48 of file CAlphaColour.hpp.
Blue
Definition at line 52 of file CAlphaColour.hpp.
Dark grey
Definition at line 59 of file CAlphaColour.hpp.
Green
Definition at line 51 of file CAlphaColour.hpp.
Light grey
Definition at line 58 of file CAlphaColour.hpp.
Orange
Definition at line 54 of file CAlphaColour.hpp.
Pink
Definition at line 57 of file CAlphaColour.hpp.
Purple
Definition at line 56 of file CAlphaColour.hpp.
Red
Definition at line 50 of file CAlphaColour.hpp.
Turqoise
Definition at line 55 of file CAlphaColour.hpp.
White
Definition at line 49 of file CAlphaColour.hpp.
Yellow
Definition at line 53 of file CAlphaColour.hpp.
unsigned long Exponent::GUI::Basics::CAlphaColour::m_alpha [protected] |
Alpha value (0 - 255)
Definition at line 216 of file CAlphaColour.hpp.
Referenced by getAlpha(), and setAlpha().