#include <OgreColourValue.h>
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. | |
float | operator[] (const size_t i) const |
Array accessor operator. | |
float & | operator[] (const size_t i) |
Array accessor operator. | |
float * | ptr () |
Pointer accessor for direct copying. | |
const float * | ptr () const |
Pointer accessor for direct copying. | |
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. | |
Public Attributes | |
float | r |
float | g |
float | b |
float | a |
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. |
Definition at line 52 of file OgreColourValue.h.
|
Definition at line 62 of file OgreColourValue.h. |
|
Retrieves colours as ABGR.
|
|
Retrieves colour as ARGB.
|
|
Retrieves colour as BGRA.
|
|
Retrieves colour as RGBA.
|
|
Definition at line 203 of file OgreColourValue.h. |
|
Definition at line 191 of file OgreColourValue.h. |
|
Definition at line 275 of file OgreColourValue.h. |
|
|
|
Definition at line 167 of file OgreColourValue.h. |
|
Definition at line 255 of file OgreColourValue.h. |
|
Definition at line 179 of file OgreColourValue.h. |
|
Definition at line 265 of file OgreColourValue.h. |
|
Definition at line 227 of file OgreColourValue.h. |
|
Definition at line 215 of file OgreColourValue.h. |
|
Definition at line 284 of file OgreColourValue.h. |
|
|
|
Array accessor operator.
Definition at line 147 of file OgreColourValue.h. |
|
Array accessor operator.
Definition at line 139 of file OgreColourValue.h. |
|
Pointer accessor for direct copying.
Definition at line 160 of file OgreColourValue.h. |
|
Pointer accessor for direct copying.
Definition at line 155 of file OgreColourValue.h. |
|
Clamps colour value to the range [0, 1].
Definition at line 106 of file OgreColourValue.h. Referenced by saturateCopy(). |
|
As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy.
Definition at line 131 of file OgreColourValue.h. References saturate(). |
|
Sets colour as ABGR.
|
|
Sets colour as ARGB.
|
|
Sets colour as BGRA.
|
|
Sets colour as RGBA.
|
|
Set a colour value from Hue, Saturation and Brightness.
|
|
Definition at line 242 of file OgreColourValue.h. |
|
Function for writing to a stream.
Definition at line 309 of file OgreColourValue.h. |
|
Definition at line 71 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), and operator/(). |
|
Definition at line 71 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), and operator/(). |
|
Definition at line 56 of file OgreColourValue.h. |
|
Definition at line 60 of file OgreColourValue.h. |
|
Definition at line 71 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), and operator/(). |
|
Definition at line 59 of file OgreColourValue.h. |
|
Definition at line 71 of file OgreColourValue.h. Referenced by operator *(), operator+(), operator+=(), operator-(), operator-=(), and operator/(). |
|
Definition at line 58 of file OgreColourValue.h. |
|
Definition at line 57 of file OgreColourValue.h. |
|
Definition at line 55 of 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 30 10:51:07 2007