Procedural::Channel Class Reference

Extract one channel or create gray image. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Channel:

Public Types
enum	CANNEL_SELECTION {   SELECT_RED, SELECT_GREEN, SELECT_BLUE, SELECT_ALPHA,   SELECT_GRAY }

Public Member Functions
	Channel (TextureBufferPtr pBuffer)
	Default constructor. More...
Channel &	setSelection (CANNEL_SELECTION selection)
	Set selection. 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

Extract one channel or create gray image.

Reduce given image to a given channel or calculate gray image of it

Examples: SELECT_BLUE

Procedural::TextureBuffer bufferImage(256);
Procedural::Image(&bufferImage).setFile("red_brick.jpg").process();
Procedural::Channel(&bufferImage).setSelection(Procedural::Channel::SELECT_BLUE).process();

SELECT_GRAY

Procedural::TextureBuffer bufferImage(256);
Procedural::Image(&bufferImage).setFile("red_brick.jpg").process();
Procedural::Channel(&bufferImage).setSelection(Procedural::Channel::SELECT_GRAY).process();

Member Enumeration Documentation

CANNEL_SELECTION

enum Procedural::Channel::CANNEL_SELECTION

Enumerator
SELECT_RED
SELECT_GREEN
SELECT_BLUE
SELECT_ALPHA
SELECT_GRAY

Constructor & Destructor Documentation

Channel()

Procedural::Channel::Channel

(

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

virtual

Run image manipulation.

Returns

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

Implements Procedural::TextureProcessing.

setLog()

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

inherited

Enable/Disable logging.

Parameters

enable

true enables logging of filter actions

setSelection()

Channel& Procedural::Channel::setSelection

(

CANNEL_SELECTION

selection

)

Set selection.

Parameters

selection

Mode which channel should selected (default SELECT_GRAY)

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