Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Protected Attributes | List of all members
Mezzanine::Graphics::Procedural::DilateModifier Class Reference

A modifier that will bright areas of the texture over the darker areas of the image. More...

#include <dilatemodifier.h>

+ Inheritance diagram for Mezzanine::Graphics::Procedural::DilateModifier:
+ Collaboration diagram for Mezzanine::Graphics::Procedural::DilateModifier:

Public Member Functions

 DilateModifier ()
 Blank constructor.
 
virtual ~DilateModifier ()
 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...
 
DilateModifierSetNumIterations (const UInt8 Iterations)
 Sets the number of times this filter will go over the texture, generating larger bright areas. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
 TextureModifier ()
 Blank constructor.
 
virtual ~TextureModifier ()
 Class destructor.
 

Protected Attributes

UInt8 NumIterations
 The number of passes over the entire image to take when expanding the bright areas. More...
 

Detailed Description

A modifier that will bright areas of the texture over the darker areas of the image.

Definition at line 82 of file dilatemodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::DilateModifier::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 132 of file dilatemodifier.cpp.

void Mezzanine::Graphics::Procedural::DilateModifier::Modify ( TextureBuffer Buffer)
virtual

Alters the generated pixels in a TextureBuffer.

Parameters
BufferThe buffer to be modified.

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

Definition at line 88 of file dilatemodifier.cpp.

DilateModifier & Mezzanine::Graphics::Procedural::DilateModifier::SetNumIterations ( const UInt8  Iterations)

Sets the number of times this filter will go over the texture, generating larger bright areas.

Parameters
IterationsThe number of passes over the entire image to take when expanding the bright areas.
Returns
Returns a reference to this.

Definition at line 138 of file dilatemodifier.cpp.

Member Data Documentation

UInt8 Mezzanine::Graphics::Procedural::DilateModifier::NumIterations
protected

The number of passes over the entire image to take when expanding the bright areas.

Definition at line 87 of file dilatemodifier.h.


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