![]() |
OGRE-Next 3.0.0
Object-Oriented Graphics Rendering Engine
|
Class representing colour. More...
#include <OgreColourValue.h>
Public Member Functions | |
| ColourValue (float red=1.0f, float green=1.0f, float blue=1.0f, float alpha=1.0f) | |
| ColourValue (Vector3 v) | |
| ColourValue (Vector4 v) | |
| void | fromVector3 (Vector3 v) |
| Sets 'this' RGB from xyz. Alpha component is left intact. | |
| void | fromVector4 (Vector4 v) |
| Sets 'this' RGBA from xyzw. | |
| ABGR | getAsABGR () const |
| Retrieves colours as ABGR. | |
| ARGB | getAsARGB () const |
| Retrieves colour as ARGB. | |
| BGRA | getAsBGRA () const |
| Retrieves colour as BGRA. | |
| RGBA | getAsRGBA () const |
| Retrieves colour as RGBA. | |
| void | getHSB (Real *hue, Real *saturation, Real *brightness) const |
| Convert the current colour to Hue, Saturation and Brightness values. | |
| bool | operator!= (const ColourValue &rhs) const |
| ColourValue | operator* (const ColourValue &rhs) const |
| ColourValue | operator* (const float fScalar) const |
| ColourValue & | operator*= (const float fScalar) |
| ColourValue | operator+ (const ColourValue &rkVector) const |
| ColourValue & | operator+= (const ColourValue &rkVector) |
| ColourValue | operator- (const ColourValue &rkVector) const |
| ColourValue & | operator-= (const ColourValue &rkVector) |
| ColourValue | operator/ (const ColourValue &rhs) const |
| ColourValue | operator/ (const float fScalar) const |
| ColourValue & | operator/= (const float fScalar) |
| bool | operator== (const ColourValue &rhs) const |
| float & | operator[] (const size_t i) |
| Array accessor operator. | |
| float | operator[] (const size_t i) const |
| Array accessor operator. | |
| float * | ptr () |
| Pointer accessor for direct copying. | |
| const float * | ptr () const |
| Pointer accessor for direct copying. | |
| void | saturate () |
| Clamps colour value to the range [0, 1]. | |
| ColourValue | saturateCopy () const |
| As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy. | |
| void | setAsABGR (const ABGR val) |
| Sets colour as ABGR. | |
| void | setAsARGB (const ARGB val) |
| Sets colour as ARGB. | |
| void | setAsBGRA (const BGRA val) |
| Sets colour as BGRA. | |
| void | setAsRGBA (const RGBA val) |
| Sets colour as RGBA. | |
| void | setHSB (Real hue, Real saturation, Real brightness) |
| Set a colour value from Hue, Saturation and Brightness. | |
| Vector3 | toVector3 () const |
| Returns the RGB in xyz as a Vector3. | |
| Vector4 | toVector4 () const |
| Returns the RGBA in xyzw component as a Vector4. | |
Public Attributes | |
| float | a |
| float | b |
| float | g |
| float | r |
Static Public Attributes | |
| static const ColourValue | Black |
| static const ColourValue | Blue |
| static const ColourValue | Green |
| static const ColourValue | Red |
| static const ColourValue | White |
| static const ColourValue | ZERO |
Class representing colour.
|
inlineexplicit |
Referenced by operator!=(), operator*(), operator*(), operator*, operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/(), operator/=(), operator<<, operator==(), and saturateCopy().
|
inlineexplicit |
References a, and fromVector3().
|
inlineexplicit |
References fromVector4().
|
inline |
Sets 'this' RGB from xyz. Alpha component is left intact.
References Ogre::Vector3::x, Ogre::Vector3::y, and Ogre::Vector3::z.
Referenced by ColourValue().
|
inline |
Sets 'this' RGBA from xyzw.
References Ogre::Vector4::w, Ogre::Vector4::x, Ogre::Vector4::y, and Ogre::Vector4::z.
Referenced by ColourValue().
Convert the current colour to Hue, Saturation and Brightness values.
| hue | Output hue value, scaled to the [0,1] range as opposed to the 0-360 |
| saturation | Output saturation level, [0,1] |
| brightness | Output brightness level, [0,1] |
| bool Ogre::ColourValue::operator!= | ( | const ColourValue & | rhs | ) | const |
References ColourValue().
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
|
inline |
References ColourValue(), a, b, g, and r.
| bool Ogre::ColourValue::operator== | ( | const ColourValue & | rhs | ) | const |
References ColourValue().
|
inline |
Array accessor operator.
References r.
|
inline |
Array accessor operator.
References r.
|
inline |
Pointer accessor for direct copying.
References r.
|
inline |
Pointer accessor for direct copying.
References r.
|
inline |
|
inline |
As saturate, except that this colour value is unaffected and the saturated colour value is returned as a copy.
References ColourValue(), and saturate().
Set a colour value from Hue, Saturation and Brightness.
| 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] |
|
inline |
|
inline |
| float Ogre::ColourValue::a |
Referenced by ColourValue(), ColourValue(), operator*(), operator*(), operator*, operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/(), operator/=(), saturate(), and toVector4().
| float Ogre::ColourValue::b |
Referenced by ColourValue(), operator*(), operator*(), operator*, operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/(), operator/=(), saturate(), toVector3(), and toVector4().
|
static |
|
static |
| float Ogre::ColourValue::g |
Referenced by ColourValue(), operator*(), operator*(), operator*, operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/(), operator/=(), saturate(), toVector3(), and toVector4().
|
static |
| float Ogre::ColourValue::r |
Referenced by ColourValue(), operator*(), operator*(), operator*, operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator/(), operator/=(), operator[](), operator[](), ptr(), ptr(), saturate(), toVector3(), and toVector4().
|
static |
|
static |
|
static |