Procedural::Alpha Class Reference

Colour extraction. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Alpha:

Public Member Functions
	Alpha (TextureBufferPtr pBuffer)
	Default constructor. More...
Alpha &	setExtractColour (Ogre::ColourValue colour)
	Set the colour to extract. More...
Alpha &	setExtractColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the colour to extract. 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

Colour extraction.

Extract single color intensity, replace it with white smoke, discard the rest.

Example:

Procedural::TextureBuffer bufferCell(256);
Procedural::Cell(&bufferCell).setDensity(4).setRegularity(234).process();
Procedural::Alpha(&bufferCell).process();

Constructor & Destructor Documentation

Alpha()

Procedural::Alpha::Alpha

(

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::Alpha::process ( )

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setExtractColour() [1/2]

Alpha& Procedural::Alpha::setExtractColour

(

Ogre::ColourValue

colour

)

Set the colour to extract.

Parameters

colour

New colour for extraction (default Ogre::ColourValue::White)

setExtractColour() [2/2]

Alpha& Procedural::Alpha::setExtractColour	(	Ogre::Real	red,
		Ogre::Real	green,
		Ogre::Real	blue,
		Ogre::Real	alpha = 1.0f
	)

Set the colour to extract.

Parameters

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

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

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