Mezzanine::Graphics::Procedural::AlphaModifier Class Reference

A modifier that will replace all pixels with "White Smoke" corresponding to the intensity of the extracted colour and the source alpha channel. More...

#include <alphamodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::AlphaModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::AlphaModifier:

Public Member Functions
	AlphaModifier ()
	Blank constructor.
virtual	~AlphaModifier ()
	Class destructor.
virtual String	GetName () const
	Gets the name of this modifier. More...
virtual void	Modify (TextureBuffer &Buffer)
	Alters the generated pixels in a TextureBuffer. More...
AlphaModifier &	SetExtractColour (const ColourValue &Extract)
	Sets the amount of colour to extract for each colour channel. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
ColourValue	ExtractColour
	The amount from each colour channel to be extracted from the source texture. More...

Detailed Description

A modifier that will replace all pixels with "White Smoke" corresponding to the intensity of the extracted colour and the source alpha channel.

The extract colour isn't used explicitly, instead each channel (except for the alpha channel) is multiplied by the corresponding channel of the source pixel. The Alpha channel value is then factored in unaltered by the ExtractColour member. Setting an alpha value to the ExtractColour has no effect.

Definition at line 83 of file alphamodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::AlphaModifier::GetName ( ) const

virtual

Gets the name of this modifier.

Returns

Returns a string containing the name of this modifier.

Implements Mezzanine::Graphics::Procedural::TextureModifier.

Definition at line 106 of file alphamodifier.cpp.

void Mezzanine::Graphics::Procedural::AlphaModifier::Modify ( TextureBuffer &  Buffer )

virtual

Alters the generated pixels in a TextureBuffer.

Parameters

Buffer

The buffer to be modified.

Implements Mezzanine::Graphics::Procedural::TextureModifier.

Definition at line 88 of file alphamodifier.cpp.

AlphaModifier & Mezzanine::Graphics::Procedural::AlphaModifier::SetExtractColour

(

const ColourValue &

Extract

)

Sets the amount of colour to extract for each colour channel.

Parameters

Extract

The amount from each colour channel to be extracted from the source texture.

Returns

Returns a reference to this.

Definition at line 112 of file alphamodifier.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::AlphaModifier::ExtractColour

protected

The amount from each colour channel to be extracted from the source texture.

Definition at line 88 of file alphamodifier.h.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Texture/alphamodifier.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/Procedural/Texture/alphamodifier.cpp