CEGUI::colour Class Reference

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

#include <CEGUIcolour.h>

List of all members.

Public Member Functions
	colour (void)
	colour (const colour &val)
	colour (float red, float green, float blue, float alpha=1.0f)
	colour (ulong argb)
	~colour (void)
ulong	getARGB (void) const
float	getAlpha (void) const
float	getRed (void) const
float	getGreen (void) const
float	getBlue (void) const
float	getHue (void) const
float	getSaturation (void) const
float	getLumination (void) const
void	setARGB (ulong argb)
void	setAlpha (float alpha)
void	setRed (float red)
void	setGreen (float green)
void	setBlue (float blue)
void	setHSL (float hue, float saturation, float luminance, float alpha=1.0f)
colour &	operator= (ulong val)
colour &	operator= (const colour &val)
colour &	operator &= (ulong val)
colour &	operator &= (const colour &val)
colour &	operator|= (ulong 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
	operator ulong () const

---

Detailed Description

Class representing colour values within the system.

Definition at line 39 of file CEGUIcolour.h.

---

Constructor & Destructor Documentation

CEGUI::colour::colour (  void   )

Definition at line 36 of file CEGUIcolour.cpp.

CEGUI::colour::colour (  const colour &  val  )

Definition at line 47 of file CEGUIcolour.cpp. References operator=().

CEGUI::colour::colour (  float  red, float  green, float  blue, float  alpha = 1.0f )

Definition at line 53 of file CEGUIcolour.cpp.

CEGUI::colour::colour (  ulong  argb  )

Definition at line 63 of file CEGUIcolour.cpp. References setARGB().

CEGUI::colour::~colour (  void   )

Definition at line 69 of file CEGUIcolour.cpp.

---

Member Function Documentation

float CEGUI::colour::getAlpha (  void   )  const [inline]

Definition at line 66 of file CEGUIcolour.h. Referenced by CEGUI::Static::calculateModulatedAlphaColour(), and CEGUI::ListboxItem::calculateModulatedAlphaColour().

ulong CEGUI::colour::getARGB (  void   )  const [inline]

Definition at line 55 of file CEGUIcolour.h. References CEGUI::ulong. Referenced by CEGUI::DirectX81Renderer::addQuad(), CEGUI::DirectX9Renderer::addQuad(), CEGUI::PropertyHelper::colourRectToString(), CEGUI::PropertyHelper::colourToString(), operator &=(), and operator|=().

float CEGUI::colour::getBlue (  void   )  const [inline]

Definition at line 69 of file CEGUIcolour.h.

float CEGUI::colour::getGreen (  void   )  const [inline]

Definition at line 68 of file CEGUIcolour.h.

float CEGUI::colour::getHue (  void   )  const

Definition at line 74 of file CEGUIcolour.cpp. References ceguimax, and ceguimin.

float CEGUI::colour::getLumination (  void   )  const

Definition at line 141 of file CEGUIcolour.cpp. References ceguimax, and ceguimin.

float CEGUI::colour::getRed (  void   )  const [inline]

Definition at line 67 of file CEGUIcolour.h.

float CEGUI::colour::getSaturation (  void   )  const

Definition at line 113 of file CEGUIcolour.cpp. References ceguimax, and ceguimin.

colour& CEGUI::colour::operator &= (  const colour &  val  )  [inline]

Definition at line 134 of file CEGUIcolour.h. References getARGB().

colour& CEGUI::colour::operator &= (  ulong  val  )  [inline]

Definition at line 128 of file CEGUIcolour.h.

colour CEGUI::colour::operator * (  const float  val  )  const [inline]

Definition at line 184 of file CEGUIcolour.h.

CEGUI::colour::operator ulong (   )  const [inline]

Definition at line 197 of file CEGUIcolour.h.

colour CEGUI::colour::operator+ (  const colour &  val  )  const [inline]

Definition at line 164 of file CEGUIcolour.h. References d_alpha, d_blue, d_green, and d_red.

colour CEGUI::colour::operator- (  const colour &  val  )  const [inline]

Definition at line 174 of file CEGUIcolour.h. References d_alpha, d_blue, d_green, and d_red.

colour& CEGUI::colour::operator<<= (  int  val  )  [inline]

Definition at line 152 of file CEGUIcolour.h.

colour& CEGUI::colour::operator= (  const colour &  val  )  [inline]

Definition at line 116 of file CEGUIcolour.h. References d_alpha, d_argb, d_argbValid, d_blue, d_green, and d_red.

colour& CEGUI::colour::operator= (  ulong  val  )  [inline]

Definition at line 110 of file CEGUIcolour.h. Referenced by colour().

colour& CEGUI::colour::operator>>= (  int  val  )  [inline]

Definition at line 158 of file CEGUIcolour.h.

colour& CEGUI::colour::operator|= (  const colour &  val  )  [inline]

Definition at line 146 of file CEGUIcolour.h. References getARGB().

colour& CEGUI::colour::operator|= (  ulong  val  )  [inline]

Definition at line 140 of file CEGUIcolour.h.

void CEGUI::colour::setAlpha (  float  alpha  )  [inline]

Definition at line 80 of file CEGUIcolour.h. Referenced by CEGUI::Static::calculateModulatedAlphaColour(), CEGUI::ListboxItem::calculateModulatedAlphaColour(), CEGUI::ColourRect::setAlpha(), CEGUI::ColourRect::setBottomAlpha(), CEGUI::ColourRect::setLeftAlpha(), CEGUI::ColourRect::setRightAlpha(), and CEGUI::ColourRect::setTopAlpha().

void CEGUI::colour::setARGB (  ulong  argb  )

Definition at line 155 of file CEGUIcolour.cpp. Referenced by colour().

void CEGUI::colour::setBlue (  float  blue  )  [inline]

Definition at line 98 of file CEGUIcolour.h.

void CEGUI::colour::setGreen (  float  green  )  [inline]

Definition at line 92 of file CEGUIcolour.h.

void CEGUI::colour::setHSL (  float  hue, float  saturation, float  luminance, float  alpha = 1.0f )

Definition at line 171 of file CEGUIcolour.cpp.

void CEGUI::colour::setRed (  float  red  )  [inline]

Definition at line 86 of file CEGUIcolour.h.

---

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

• CEGUIcolour.h
• CEGUIcolour.cpp

---