Mezzanine::Graphics::Procedural::JitterModifier Class Reference

A modifier that will randomly shuffle the pixel being processed to a nearby position. More...

#include <jittermodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::JitterModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::JitterModifier:

Public Member Functions
	JitterModifier ()
	Blank constructor.
virtual	~JitterModifier ()
	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...
JitterModifier &	SetGeneratorSeed (const Whole Seed)
	Sets the seed for the "random" number generator. More...
JitterModifier &	SetJitterRadius (const UInt16 Radius)
	Sets the range in which pixels can be swapped. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
Whole	GeneratorSeed
	The seed to be used for the random number generator. More...
UInt16	JitterRadius
	The radius around the pixel being processed in which the pixel can be displaced. More...

Detailed Description

A modifier that will randomly shuffle the pixel being processed to a nearby position.

Definition at line 82 of file jittermodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::JitterModifier::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 114 of file jittermodifier.cpp.

void Mezzanine::Graphics::Procedural::JitterModifier::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 jittermodifier.cpp.

JitterModifier & Mezzanine::Graphics::Procedural::JitterModifier::SetGeneratorSeed

(

const Whole

Seed

)

Sets the seed for the "random" number generator.

Parameters

Seed	The seed value for the random number generator. Initial Value: 5120.

Returns

Returns a reference to this.

Definition at line 120 of file jittermodifier.cpp.

JitterModifier & Mezzanine::Graphics::Procedural::JitterModifier::SetJitterRadius

(

const UInt16

Radius

)

Sets the range in which pixels can be swapped.

Parameters

Radius

The radius around the pixel being processed in which the pixel can be displaced. Initial Value: 32.

Returns

Returns a reference to this.

Definition at line 126 of file jittermodifier.cpp.

Member Data Documentation

Whole Mezzanine::Graphics::Procedural::JitterModifier::GeneratorSeed

protected

The seed to be used for the random number generator.

Definition at line 87 of file jittermodifier.h.

UInt16 Mezzanine::Graphics::Procedural::JitterModifier::JitterRadius

protected

The radius around the pixel being processed in which the pixel can be displaced.

Definition at line 90 of file jittermodifier.h.

---

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

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