Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

# Ogre::ColourValue Class Reference

Class representing colour. More...

`#include <OgreColourValue.h>`

List of all members.

## Public Methods

| ColourValue (Real red=1.0f, Real green=1.0f, Real blue=1.0f, Real alpha=1.0f)
bool | operator== (const ColourValue &rhs) const
bool | operator!= (const ColourValue &rhs) const
RGBA | getAsLongRGBA (void) const
| Retrieves colour as RGBA.
ARGB | getAsLongARGB (void) const
| Retrieves colour as ARGB.
ABGR | getAsLongABGR (void) const
| Retrieves colours as ABGR.
ColourValue | operator+ (const ColourValue &rkVector) const
ColourValue | operator- (const ColourValue &rkVector) const
ColourValue | operator * (Real fScalar) const
ColourValue | operator * (const ColourValue &rhs) const
ColourValue | operator/ (const ColourValue &rhs) const
ColourValue | operator/ (Real fScalar) const
ColourValue & | operator+= (const ColourValue &rkVector)
ColourValue & | operator-= (const ColourValue &rkVector)
ColourValue & | operator *= (Real fScalar)
ColourValue & | operator/= (Real fScalar)

## Static Public Attributes

ColourValue | Black = ColourValue(0.0,0.0,0.0)
ColourValue | White = ColourValue(1.0,1.0,1.0)
ColourValue | Red = ColourValue(1.0,0.0,0.0)
ColourValue | Green = ColourValue(0.0,1.0,0.0)
ColourValue | Blue = ColourValue(0.0,0.0,1.0)

## Friends

ColourValue | operator * (Real fScalar, const ColourValue &rkVector)

## 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 47 of file OgreColourValue.h.

## Constructor & Destructor Documentation

Ogre::ColourValue::ColourValue | ( | Real | red = 1.0f,
|  | Real | green = 1.0f,
|  | Real | blue = 1.0f,
|  | Real | alpha = 1.0f
| ) |

| Definition at line 56 of file OgreColourValue.h. References Ogre::green, and Ogre::Real.

## Member Function Documentation

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

| Retrieves colours as ABGR. Definition at line 92 of file OgreColourValue.cpp. References a, Ogre::ABGR, b, g, and r. Referenced by Ogre::GLRenderSystem::convertColourValue().

unsigned long Ogre::ColourValue::getAsLongARGB | ( | void |  | ) | const

| Retrieves colour as ARGB. Definition at line 64 of file OgreColourValue.cpp. References a, b, g, and r. Referenced by Ogre::D3D9RenderSystem::_setFog(), Ogre::D3DRenderSystem::_setFog(), Ogre::D3D9RenderSystem::clearFrameBuffer(), Ogre::D3DRenderSystem::clearFrameBuffer(), Ogre::D3D9RenderSystem::convertColourValue(), and Ogre::D3DRenderSystem::convertColourValue().

unsigned long Ogre::ColourValue::getAsLongRGBA | ( | void |  | ) | const

| Retrieves colour as RGBA. Definition at line 37 of file OgreColourValue.cpp. References a, b, g, and r. Referenced by Ogre::GLRenderSystem::convertColourValue().

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

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

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

| Definition at line 108 of file OgreColourValue.h. References a, b, g, r, and Ogre::Real.

ColourValue& Ogre::ColourValue::operator *= | ( | Real | fScalar | ) |

| Definition at line 192 of file OgreColourValue.h. References Ogre::Real.

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

| Definition at line 128 of file OgreColourValue.cpp.

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

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

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

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

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

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

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

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

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

| Definition at line 144 of file OgreColourValue.h. References a, b, g, r, and Ogre::Real.

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

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

ColourValue& Ogre::ColourValue::operator/= | ( | Real | fScalar | ) |

| Definition at line 201 of file OgreColourValue.h. References Ogre::Real.

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

| Definition at line 120 of file OgreColourValue.cpp. References a, b, g, and r.

## Friends And Related Function Documentation

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

| Definition at line 159 of file OgreColourValue.h.

## Member Data Documentation

Real Ogre::ColourValue::a

Definition at line 67 of file OgreColourValue.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ColourFaderAffector::_affectParticles(), Ogre::ColourImageAffector::_initParticle(), Ogre::GLRenderSystem::_setFog(), Ogre::GLRenderSystem::_setSurfaceParams(), Ogre::D3D9RenderSystem::_setSurfaceParams(), Ogre::D3DRenderSystem::_setSurfaceParams(), Ogre::GLRenderSystem::_setTextureBlendMode(), Ogre::D3D9RenderSystem::_setTextureBlendMode(), Ogre::GLRenderSystem::clearFrameBuffer(), Ogre::ParticleEmitter::genEmissionColour(), getAsLongABGR(), getAsLongARGB(), getAsLongRGBA(), operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator==(), Ogre::parseColourOpEx(), Ogre::D3D9RenderSystem::setD3D9Light(), Ogre::D3DRenderSystem::setD3DLight(), Ogre::Technique::setDiffuse(), Ogre::Pass::setDiffuse(), Ogre::Material::setDiffuse(), Ogre::GLRenderSystem::setGLLight(), Ogre::Technique::setSpecular(), Ogre::Pass::setSpecular(), Ogre::Material::setSpecular(), Ogre::StringConverter::toString(), Ogre::MaterialSerializer::writeColourValue(), and Ogre::MaterialSerializer::writePass().

Real Ogre::ColourValue::b

Definition at line 67 of file OgreColourValue.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ColourFaderAffector::_affectParticles(), Ogre::TerrainRenderable::_generateVertexLighting(), Ogre::ColourImageAffector::_initParticle(), Ogre::GLRenderSystem::_setFog(), Ogre::GLRenderSystem::_setSurfaceParams(), Ogre::D3D9RenderSystem::_setSurfaceParams(), Ogre::D3DRenderSystem::_setSurfaceParams(), Ogre::GLRenderSystem::_setTextureBlendMode(), Ogre::D3D9RenderSystem::_setTextureBlendMode(), Ogre::D3DRenderSystem::_setTextureBlendMode(), Ogre::GLRenderSystem::clearFrameBuffer(), Ogre::ParticleEmitter::genEmissionColour(), getAsLongABGR(), getAsLongARGB(), getAsLongRGBA(), operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator==(), Ogre::parseColourOpEx(), Ogre::SceneManager::renderTextureShadowCasterQueueGroupObjects(), Ogre::SceneManager::renderTextureShadowReceiverQueueGroupObjects(), Ogre::Technique::setAmbient(), Ogre::Pass::setAmbient(), Ogre::Material::setAmbient(), Ogre::SceneManager::setAmbientLight(), Ogre::D3D9RenderSystem::setD3D9Light(), Ogre::D3DRenderSystem::setD3DLight(), Ogre::Technique::setDiffuse(), Ogre::Pass::setDiffuse(), Ogre::Material::setDiffuse(), Ogre::Light::setDiffuseColour(), Ogre::GLRenderSystem::setGLLight(), Ogre::Technique::setSelfIllumination(), Ogre::Pass::setSelfIllumination(), Ogre::Material::setSelfIllumination(), Ogre::Technique::setSpecular(), Ogre::Pass::setSpecular(), Ogre::Material::setSpecular(), Ogre::Light::setSpecularColour(), Ogre::StringConverter::toString(), Ogre::MaterialSerializer::writeColourValue(), and Ogre::MaterialSerializer::writePass().

ColourValue Ogre::ColourValue::Black = ColourValue(0.0,0.0,0.0)`[static]`

| Definition at line 30 of file OgreColourValue.cpp.

ColourValue Ogre::ColourValue::Blue = ColourValue(0.0,0.0,1.0)`[static]`

| Definition at line 34 of file OgreColourValue.cpp.

Real Ogre::ColourValue::g

Definition at line 67 of file OgreColourValue.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ColourFaderAffector::_affectParticles(), Ogre::TerrainRenderable::_generateVertexLighting(), Ogre::ColourImageAffector::_initParticle(), Ogre::GLRenderSystem::_setFog(), Ogre::GLRenderSystem::_setSurfaceParams(), Ogre::D3D9RenderSystem::_setSurfaceParams(), Ogre::D3DRenderSystem::_setSurfaceParams(), Ogre::GLRenderSystem::_setTextureBlendMode(), Ogre::D3D9RenderSystem::_setTextureBlendMode(), Ogre::D3DRenderSystem::_setTextureBlendMode(), Ogre::GLRenderSystem::clearFrameBuffer(), Ogre::ParticleEmitter::genEmissionColour(), getAsLongABGR(), getAsLongARGB(), getAsLongRGBA(), operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator==(), Ogre::parseColourOpEx(), Ogre::SceneManager::renderTextureShadowCasterQueueGroupObjects(), Ogre::SceneManager::renderTextureShadowReceiverQueueGroupObjects(), Ogre::Technique::setAmbient(), Ogre::Pass::setAmbient(), Ogre::Material::setAmbient(), Ogre::SceneManager::setAmbientLight(), Ogre::D3D9RenderSystem::setD3D9Light(), Ogre::D3DRenderSystem::setD3DLight(), Ogre::Technique::setDiffuse(), Ogre::Pass::setDiffuse(), Ogre::Material::setDiffuse(), Ogre::Light::setDiffuseColour(), Ogre::GLRenderSystem::setGLLight(), Ogre::Technique::setSelfIllumination(), Ogre::Pass::setSelfIllumination(), Ogre::Material::setSelfIllumination(), Ogre::Technique::setSpecular(), Ogre::Pass::setSpecular(), Ogre::Material::setSpecular(), Ogre::Light::setSpecularColour(), Ogre::StringConverter::toString(), Ogre::MaterialSerializer::writeColourValue(), and Ogre::MaterialSerializer::writePass().

ColourValue Ogre::ColourValue::Green = ColourValue(0.0,1.0,0.0)`[static]`

| Definition at line 33 of file OgreColourValue.cpp.

Real Ogre::ColourValue::r

Definition at line 67 of file OgreColourValue.h.

Referenced by Ogre::ColourInterpolatorAffector::_affectParticles(), Ogre::ColourImageAffector::_affectParticles(), Ogre::ColourFaderAffector2::_affectParticles(), Ogre::ColourFaderAffector::_affectParticles(), Ogre::TerrainRenderable::_generateVertexLighting(), Ogre::ColourImageAffector::_initParticle(), Ogre::GLRenderSystem::_setFog(), Ogre::GLRenderSystem::_setSurfaceParams(), Ogre::D3D9RenderSystem::_setSurfaceParams(), Ogre::D3DRenderSystem::_setSurfaceParams(), Ogre::GLRenderSystem::_setTextureBlendMode(), Ogre::D3D9RenderSystem::_setTextureBlendMode(), Ogre::D3DRenderSystem::_setTextureBlendMode(), Ogre::GLRenderSystem::clearFrameBuffer(), Ogre::ParticleEmitter::genEmissionColour(), getAsLongABGR(), getAsLongARGB(), getAsLongRGBA(), operator *(), operator+(), operator+=(), operator-(), operator-=(), operator/(), operator==(), Ogre::parseColourOpEx(), Ogre::SceneManager::renderTextureShadowCasterQueueGroupObjects(), Ogre::SceneManager::renderTextureShadowReceiverQueueGroupObjects(), Ogre::Technique::setAmbient(), Ogre::Pass::setAmbient(), Ogre::Material::setAmbient(), Ogre::SceneManager::setAmbientLight(), Ogre::D3D9RenderSystem::setD3D9Light(), Ogre::D3DRenderSystem::setD3DLight(), Ogre::Technique::setDiffuse(), Ogre::Pass::setDiffuse(), Ogre::Material::setDiffuse(), Ogre::Light::setDiffuseColour(), Ogre::GLRenderSystem::setGLLight(), Ogre::Technique::setSelfIllumination(), Ogre::Pass::setSelfIllumination(), Ogre::Material::setSelfIllumination(), Ogre::Technique::setSpecular(), Ogre::Pass::setSpecular(), Ogre::Material::setSpecular(), Ogre::Light::setSpecularColour(), Ogre::StringConverter::toString(), Ogre::MaterialSerializer::writeColourValue(), and Ogre::MaterialSerializer::writePass().

ColourValue Ogre::ColourValue::Red = ColourValue(1.0,0.0,0.0)`[static]`

| Definition at line 32 of file OgreColourValue.cpp.

Real Ogre::ColourValue::val[4]

| Definition at line 69 of file OgreColourValue.h. Referenced by Ogre::GpuProgramParameters::setConstant().

ColourValue Ogre::ColourValue::White = ColourValue(1.0,1.0,1.0)`[static]`

| Definition at line 31 of file OgreColourValue.cpp.

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

- OgreColourValue.h
- OgreColourValue.cpp

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:50:50 2004