Procedural::Combine Class Reference

Combine inputs together. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Combine:

Public Types
enum	COMBINE_METHOD {   METHOD_ADD_CLAMP, METHOD_ADD_WRAP, METHOD_SUB_CLAMP, METHOD_SUB_WRAP,   METHOD_MULTIPLY, METHOD_MULTIPLY2, METHOD_BLEND, METHOD_ALPHA,   METHOD_LAYER }
	Methods how to combine image. More...

Public Member Functions
	Combine (TextureBufferPtr pBuffer)
	Default constructor. More...
Combine &	addImage (TextureBufferPtr image, COMBINE_METHOD method=METHOD_LAYER)
	Add image to process queue. More...
Combine &	setColour (Ogre::ColourValue colour)
	Set the percent colour to add on image. More...
Combine &	setColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
	Set the percent colour to add on 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

Combine inputs together.

Provides several ways of combining. Clamps bitmap to base input size.

Example:

// Image input
Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();
 
// Image structure
Procedural::TextureBuffer bufferCloud(256);
Procedural::Cloud(&bufferCloud).process();
 
// Filter
Procedural::Combine(&bufferCloud).addImage(&bufferGradient, Procedural::Combine::METHOD_ADD_CLAMP).process();

Member Enumeration Documentation

COMBINE_METHOD

enum Procedural::Combine::COMBINE_METHOD

Methods how to combine image.

Enumerator
METHOD_ADD_CLAMP
METHOD_ADD_WRAP
METHOD_SUB_CLAMP
METHOD_SUB_WRAP
METHOD_MULTIPLY
METHOD_MULTIPLY2
METHOD_BLEND
METHOD_ALPHA
METHOD_LAYER

Constructor & Destructor Documentation

Combine()

Procedural::Combine::Combine

(

TextureBufferPtr

pBuffer

)

Default constructor.

Parameters

pBuffer

Image buffer where to modify the image.

Member Function Documentation

addImage()

Combine& Procedural::Combine::addImage	(	TextureBufferPtr	image,
		COMBINE_METHOD	method = METHOD_LAYER
	)

Add image to process queue.

Parameters

image	Pointer on image to process
method	Method how to process the image

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setColour() [1/2]

Combine& Procedural::Combine::setColour

(

Ogre::ColourValue

colour

)

Set the percent colour to add on image.

Parameters

colour

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

setColour() [2/2]

Combine& Procedural::Combine::setColour	(	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 drawing colour [0.0, 1.0] (default 1.0)
green	Green value of drawing colour [0.0, 1.0] (default 1.0)
blue	Blue value of drawing colour [0.0, 1.0] (default 1.0)
alpha	Alpha value of drawing 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