CEGUI::Colour Class Reference

Class representing colour values within the system. More...

Inheritance diagram for CEGUI::Colour:

Collaboration diagram for CEGUI::Colour:

Public Member Functions
	Colour (const Colour &val)
	Colour (float red, float green, float blue, float alpha=1.0f)
	Colour (argb_t argb)
argb_t	getARGB (void) const
float	getAlpha (void) const
float	getRed (void) const
float	getGreen (void) const
float	getBlue (void) const
float	getHue (void) const
	Calculates and returns the hue value based on the Colour. More...
float	getSaturation (void) const
	Calculates and returns the saturation value based on the Colour. More...
float	getLumination (void) const
	Calculates and returns the lumination value based on the Colour. More...
void	setARGB (argb_t argb)
void	setAlpha (float alpha)
void	setRed (float red)
void	setGreen (float green)
void	setBlue (float blue)
void	set (float red, float green, float blue, float alpha=1.0f)
void	setRGB (float red, float green, float blue)
void	setRGB (const Colour &val)
void	setHSL (float hue, float saturation, float luminance, float alpha=1.0f)
void	invertColour (void)
void	invertColourWithAlpha (void)
Colour &	operator= (argb_t val)
Colour &	operator= (const Colour &val)
Colour &	operator&= (argb_t val)
Colour &	operator&= (const Colour &val)
Colour &	operator|= (argb_t val)
Colour &	operator|= (const Colour &val)
Colour &	operator<<= (int val)
Colour &	operator>>= (int val)
Colour	operator+ (const Colour &val) const
Colour	operator- (const Colour &val) const
Colour	operator* (const float val) const
Colour &	operator*= (const Colour &val)
bool	operator== (const Colour &rhs) const
bool	operator!= (const Colour &rhs) const
	operator argb_t () const

Detailed Description

Class representing colour values within the system.

Member Function Documentation

float CEGUI::Colour::getHue

(

void

)

const

Calculates and returns the hue value based on the Colour.

Returns

The hue as a float value.

float CEGUI::Colour::getLumination

(

void

)

const

Calculates and returns the lumination value based on the Colour.

Returns

The lumination as a float value.

float CEGUI::Colour::getSaturation

(

void

)

const

Calculates and returns the saturation value based on the Colour.

Returns

The saturation as a float value.