Procedural::AlphaMask Class Reference

Use alpha channel as an mask for an other image. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::AlphaMask:

Public Member Functions
	AlphaMask (TextureBufferPtr pBuffer)
	Default constructor. More...
AlphaMask &	setColourAlphaMask (bool colourmask)
	Set mode of alpha masking. More...
AlphaMask &	setParameterImage (TextureBufferPtr image)
	Set parameter image for masking/colouring. 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

Use alpha channel as an mask for an other image.

1. Extract alpha channel as an opaque monochrome bitmap or
2. multiply alpha channel with prameter image luminance, or
3. use parameter image as color alpha mask.

The luminance is not taken into account.

Example:

Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).setColours(Ogre::ColourValue::Black, Ogre::ColourValue::Red, Ogre::ColourValue::Green, Ogre::ColourValue::Blue).process();
 
Procedural::TextureBuffer bufferCell(256);
Procedural::Cell(&bufferCell).setDensity(4).setRegularity(234).process();
 
Procedural::AlphaMask(&bufferGradient).setParameterImage(&bufferCell).process();

Constructor & Destructor Documentation

AlphaMask()

Procedural::AlphaMask::AlphaMask

(

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setColourAlphaMask()

AlphaMask& Procedural::AlphaMask::setColourAlphaMask

(

bool

colourmask

)

Set mode of alpha masking.

Parameters

colourmask

If set to true parameter image will be used as alph mask (default false)

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setParameterImage()

AlphaMask& Procedural::AlphaMask::setParameterImage

(

TextureBufferPtr

image

)

Set parameter image for masking/colouring.

Parameters

image

Pointer to second image (default NULL)

Note

Methode 1 is used if the parameter image is set to zero. If the size of the parameter image is smaller than the base buffer the operation will be canceled without any image manipulation.

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