Mezzanine::Graphics::Procedural::SegmentModifier Class Reference

A modifier that will alter the colour of pixels above a certain luminous value. More...

#include <segmentmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::SegmentModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::SegmentModifier:

Public Member Functions
	SegmentModifier ()
	Blank constructor.
virtual	~SegmentModifier ()
	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...
SegmentModifier &	SetColourSource (TextureBuffer *Source)
	Sets the buffer to use to determine the colour to be placed. More...
SegmentModifier &	SetThreshold (const UInt8 Thresh)
	Sets the threshold above which the colour from the set buffer will be copied. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
TextureBuffer *	ColourSource
	The source image (buffer) to use for the replacing colour. More...
UInt8	Threshold
	The luminous threshold above which will have it's colour replaced. More...

Detailed Description

A modifier that will alter the colour of pixels above a certain luminous value.

Definition at line 82 of file segmentmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::SegmentModifier::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 157 of file segmentmodifier.cpp.

void Mezzanine::Graphics::Procedural::SegmentModifier::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 91 of file segmentmodifier.cpp.

SegmentModifier & Mezzanine::Graphics::Procedural::SegmentModifier::SetColourSource

(

TextureBuffer *

Source

)

Sets the buffer to use to determine the colour to be placed.

Parameters

Source

The source image (buffer) to use for the replacing colour.

Returns

Returns a reference to this.

Definition at line 163 of file segmentmodifier.cpp.

SegmentModifier & Mezzanine::Graphics::Procedural::SegmentModifier::SetThreshold

(

const UInt8

Thresh

)

Sets the threshold above which the colour from the set buffer will be copied.

Parameters

Thresh

The luminous threshold above which will have it's colour replaced. Initial Value: 128.

Returns

Returns a reference to this.

Definition at line 166 of file segmentmodifier.cpp.

Member Data Documentation

TextureBuffer* Mezzanine::Graphics::Procedural::SegmentModifier::ColourSource

protected

The source image (buffer) to use for the replacing colour.

Definition at line 87 of file segmentmodifier.h.

UInt8 Mezzanine::Graphics::Procedural::SegmentModifier::Threshold

protected

The luminous threshold above which will have it's colour replaced.

Definition at line 90 of file segmentmodifier.h.

---

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

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