# Ogre::ColourValue Class Reference

Class representing colour. More...

`#include <OgreColourValue.h>`

List of all members.

## Public Member Functions

| ColourValue (float red=1.0f, float green=1.0f, float blue=1.0f, float alpha=1.0f)
bool | operator== (const ColourValue &rhs) const
bool | operator!= (const ColourValue &rhs) const
RGBA | getAsRGBA (void) const
| Retrieves colour as RGBA.
ARGB | getAsARGB (void) const
| Retrieves colour as ARGB.
BGRA | getAsBGRA (void) const
| Retrieves colour as BGRA.
ABGR | getAsABGR (void) const
| Retrieves colours as ABGR.
void | setAsRGBA (const RGBA val)
| Sets colour as RGBA.
void | setAsARGB (const ARGB val)
| Sets colour as ARGB.
void | setAsBGRA (const BGRA val)
| Sets colour as BGRA.
void | setAsABGR (const ABGR val)
| Sets colour as ABGR.
void | saturate (void)
| Clamps colour value to the range [0, 1].
ColourValue | saturateCopy (void) const
| As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy.
ColourValue | operator+ (const ColourValue &rkVector) const
ColourValue | operator- (const ColourValue &rkVector) const
ColourValue | operator * (const float fScalar) const
ColourValue | operator * (const ColourValue &rhs) const
ColourValue | operator/ (const ColourValue &rhs) const
ColourValue | operator/ (const float fScalar) const
ColourValue & | operator+= (const ColourValue &rkVector)
ColourValue & | operator-= (const ColourValue &rkVector)
ColourValue & | operator *= (const float fScalar)
ColourValue & | operator/= (const float fScalar)
void | setHSB (Real hue, Real saturation, Real brightness)
| Set a colour value from Hue, Saturation and Brightness.

## Static Public Attributes

static const ColourValue | ZERO
static const ColourValue | Black
static const ColourValue | White
static const ColourValue | Red
static const ColourValue | Green
static const ColourValue | Blue

## Friends

ColourValue | operator * (const float fScalar, const ColourValue &rkVector)
_OgreExport friend std::ostream & | operator<< (std::ostream &o, const ColourValue &c)
| Function for writing to a stream.

## Detailed Description

Class representing colour.

Remarks:
  Colour is represented as 4 components, each of which is a floating-point value from 0.0 to 1.0.

  The 3 'normal' colour components are red, green and blue, a higher number indicating greater amounts of that component in the colour. The forth component is the 'alpha' value, which represents transparency. In this case, 0.0 is completely transparent and 1.0 is fully opaque.

Definition at line 48 of file OgreColourValue.h.

## Constructor & Destructor Documentation

Ogre::ColourValue::ColourValue | ( | float | red = `1.0f`,
|  | float | green = `1.0f`,
|  | float | blue = `1.0f`,
|  | float | alpha = `1.0f`
| ) | `[explicit]`

| Definition at line 58 of file OgreColourValue.h.

## Member Function Documentation

ABGR Ogre::ColourValue::getAsABGR | ( | void |  | ) | const

| Retrieves colours as ABGR.

ARGB Ogre::ColourValue::getAsARGB | ( | void |  | ) | const

| Retrieves colour as ARGB.

BGRA Ogre::ColourValue::getAsBGRA | ( | void |  | ) | const

| Retrieves colour as BGRA.

RGBA Ogre::ColourValue::getAsRGBA | ( | void |  | ) | const

| Retrieves colour as RGBA.

ColourValue Ogre::ColourValue::operator * | ( | const ColourValue & | rhs | ) | const

| Definition at line 176 of file OgreColourValue.h. References a, b, g, and r.

ColourValue Ogre::ColourValue::operator * | ( | const float | fScalar | ) | const

| Definition at line 164 of file OgreColourValue.h. References a, b, g, and r.

ColourValue& Ogre::ColourValue::operator *= | ( | const float | fScalar | ) |

| Definition at line 248 of file OgreColourValue.h.

bool Ogre::ColourValue::operator!= | ( | const ColourValue & | rhs | ) | const

ColourValue Ogre::ColourValue::operator+ | ( | const ColourValue & | rkVector | ) | const

| Definition at line 140 of file OgreColourValue.h. References a, b, g, and r.

ColourValue& Ogre::ColourValue::operator+= | ( | const ColourValue & | rkVector | ) |

| Definition at line 228 of file OgreColourValue.h. References a, b, g, and r.

ColourValue Ogre::ColourValue::operator- | ( | const ColourValue & | rkVector | ) | const

| Definition at line 152 of file OgreColourValue.h. References a, b, g, and r.

ColourValue& Ogre::ColourValue::operator-= | ( | const ColourValue & | rkVector | ) |

| Definition at line 238 of file OgreColourValue.h. References a, b, g, and r.

ColourValue Ogre::ColourValue::operator/ | ( | const float | fScalar | ) | const

| Definition at line 200 of file OgreColourValue.h. References a, b, g, and r.

ColourValue Ogre::ColourValue::operator/ | ( | const ColourValue & | rhs | ) | const

| Definition at line 188 of file OgreColourValue.h. References a, b, g, and r.

ColourValue& Ogre::ColourValue::operator/= | ( | const float | fScalar | ) |

| Definition at line 257 of file OgreColourValue.h.

bool Ogre::ColourValue::operator== | ( | const ColourValue & | rhs | ) | const

void Ogre::ColourValue::saturate | ( | void |  | ) |

| Clamps colour value to the range [0, 1]. Definition at line 107 of file OgreColourValue.h. Referenced by saturateCopy().

ColourValue Ogre::ColourValue::saturateCopy | ( | void |  | ) | const

| As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy. Definition at line 132 of file OgreColourValue.h. References saturate().

void Ogre::ColourValue::setAsABGR | ( | const ABGR | val | ) |

| Sets colour as ABGR.

void Ogre::ColourValue::setAsARGB | ( | const ARGB | val | ) |

| Sets colour as ARGB.

void Ogre::ColourValue::setAsBGRA | ( | const BGRA | val | ) |

| Sets colour as BGRA.

void Ogre::ColourValue::setAsRGBA | ( | const RGBA | val | ) |

| Sets colour as RGBA.

void Ogre::ColourValue::setHSB | ( | Real | hue,
|  | Real | saturation,
|  | Real | brightness
| ) |

Set a colour value from Hue, Saturation and Brightness.

Parameters:

  | hue | Hue value, scaled to the [0,1] range as opposed to the 0-360
  | saturation | Saturation level, [0,1]
  | brightness | Brightness level, [0,1]

## Friends And Related Function Documentation

ColourValue operator * | ( | const float | fScalar,
|  | const ColourValue & | rkVector
| ) | `[friend]`

| Definition at line 215 of file OgreColourValue.h.

_OgreExport friend std::ostream& operator<< | ( | std::ostream & | o,
|  | const ColourValue & | c
| ) | `[friend]`

| Function for writing to a stream. Definition at line 282 of file OgreColourValue.h.

## Member Data Documentation

float Ogre::ColourValue::a

| Definition at line 69 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), and Ogre::AnimableValue::setAsBaseValue().

float Ogre::ColourValue::b

| Definition at line 69 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), and Ogre::AnimableValue::setAsBaseValue().

const ColourValue Ogre::ColourValue::Black `[static]`

| Definition at line 52 of file OgreColourValue.h.

const ColourValue Ogre::ColourValue::Blue `[static]`

| Definition at line 56 of file OgreColourValue.h.

float Ogre::ColourValue::g

| Definition at line 69 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), and Ogre::AnimableValue::setAsBaseValue().

const ColourValue Ogre::ColourValue::Green `[static]`

| Definition at line 55 of file OgreColourValue.h.

float Ogre::ColourValue::r

| Definition at line 69 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), and Ogre::AnimableValue::setAsBaseValue().

const ColourValue Ogre::ColourValue::Red `[static]`

| Definition at line 54 of file OgreColourValue.h.

float Ogre::ColourValue::val[4]

| Definition at line 71 of file OgreColourValue.h.

const ColourValue Ogre::ColourValue::White `[static]`

| Definition at line 53 of file OgreColourValue.h.

const ColourValue Ogre::ColourValue::ZERO `[static]`

| Definition at line 51 of file OgreColourValue.h.

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

- OgreColourValue.h

Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Sep 17 15:39:29 2006