Procedural::Colours Class Reference

A colour filter. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Colours:

Public Member Functions
	Colours (TextureBufferPtr pBuffer)
	Default constructor. More...
Colours &	setColourBase (Ogre::ColourValue colour)
	Set the base colour to work on. More...
Colours &	setColourBase (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the base colour to work on. More...
Colours &	setColourPercent (Ogre::ColourValue colour)
	Set the percent colour to add on image. More...
Colours &	setColourPercent (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the percent colour to add on image. More...
Colours &	setBrightness (Ogre::uchar brightness)
	Set brightness of the image. More...
Colours &	setContrast (Ogre::uchar contrast)
	Set contrast of the image. More...
Colours &	setSaturation (Ogre::uchar saturation)
	Set saturation of the image. More...
Colours &	setAlpha (Ogre::uchar alpha)
	Set alpha of the image. More...
TextureBufferPtr	process ()
	Run image manipulation. More...
Ogre::String	getName ()
	Get name of the filter as string. More...
void	setLog (bool enable=true)
	Enable/Disable logging. More...

Protected Member Functions
void	logMsg (Ogre::String msg)

Protected Attributes
TextureBufferPtr	mBuffer
Ogre::String	mName
bool	mLog

Detailed Description

A colour filter.

Adjust colour, contrast, brightness and alpha.

Example:

Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();
Procedural::Colours(&bufferGradient).setColourBase(Ogre::ColourValue::Red).setColourPercent(Ogre::ColourValue::Blue).process();

Constructor & Destructor Documentation

Colours()

Procedural::Colours::Colours

(

TextureBufferPtr

pBuffer

)

Default constructor.

Parameters

pBuffer

Image buffer where to modify the image.

Member Function Documentation

getName()

Ogre::String Procedural::TextureProcessing::getName ( )

inherited

Get name of the filter as string.

logMsg()

void Procedural::TextureProcessing::logMsg ( Ogre::String  msg )

protectedinherited

process()

TextureBufferPtr Procedural::Colours::process ( )

virtual

Run image manipulation.

Returns

Pointer to image buffer which has been set in the constructor.

Implements Procedural::TextureProcessing.

setAlpha()

Colours& Procedural::Colours::setAlpha

(

Ogre::uchar

alpha

)

Set alpha of the image.

Parameters

alpha

New image alpha (default 127)

setBrightness()

Colours& Procedural::Colours::setBrightness

(

Ogre::uchar

brightness

)

Set brightness of the image.

Parameters

brightness

New image brightness (default 127)

setColourBase() [1/2]

Colours& Procedural::Colours::setColourBase

(

Ogre::ColourValue

colour

)

Set the base colour to work on.

Parameters

colour

New colour to work on (default Ogre::ColourValue::Black)

setColourBase() [2/2]

Colours& Procedural::Colours::setColourBase	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the base colour to work on.

Parameters

red	Red value of base colour [0.0, 1.0] (default 0.0)
green	Green value of base colour [0.0, 1.0] (default 0.0)
blue	Blue value of base colour [0.0, 1.0] (default 0.0)
alpha	Alpha value of base colour [0.0, 1.0] (default 0.0)

setColourPercent() [1/2]

Colours& Procedural::Colours::setColourPercent

(

Ogre::ColourValue

colour

)

Set the percent colour to add on image.

Parameters

colour

New colour to add (default Ogre::ColourValue::White)

setColourPercent() [2/2]

Colours& Procedural::Colours::setColourPercent	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the percent colour to add on image.

Parameters

red	Red value of percent colour [0.0, 1.0] (default 1.0)
green	Green value of percent colour [0.0, 1.0] (default 1.0)
blue	Blue value of percent colour [0.0, 1.0] (default 1.0)
alpha	Alpha value of percent colour [0.0, 1.0] (default 1.0)

setContrast()

Colours& Procedural::Colours::setContrast

(

Ogre::uchar

contrast

)

Set contrast of the image.

Parameters

contrast

New image contrast (default 127)

setLog()

void Procedural::TextureProcessing::setLog ( bool  enable = true )

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setSaturation()

Colours& Procedural::Colours::setSaturation

(

Ogre::uchar

saturation

)

Set saturation of the image.

Parameters

saturation

New image saturation (default 127)

Member Data Documentation

mBuffer

TextureBufferPtr Procedural::TextureProcessing::mBuffer

protectedinherited

mLog

bool Procedural::TextureProcessing::mLog

protectedinherited

mName

Ogre::String Procedural::TextureProcessing::mName

protectedinherited

---

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

• ProceduralTextureModifiers.h