Mezzanine::Graphics::Procedural::BlurModifier Class Reference

A modifier that will attempt to reduce the sharpness of the texture. More...

#include <blurmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::BlurModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::BlurModifier:

Public Types
enum	BlurType { BT_Box = 1, BT_Mean = 2, BT_Gaussian = 3 }
	An enum used to describe the Blur algorithm to use.

Public Member Functions
	BlurModifier ()
	Blank constructor.
virtual	~BlurModifier ()
	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...
BlurModifier &	SetBlockSize (const UInt8 Size)
	Sets the sample size for each pixel to be processed. More...
BlurModifier &	SetBlurType (const BlurType Blur)
	Sets the type of bluring operation to be used. More...
BlurModifier &	SetSigma (const UInt8 Sigma)
	Sets the sigma for each each pixel to be processed. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
UInt8	BlurBlockSize
	The size of the block of pixels around each pixel to be processed that will be sampled. More...
UInt8	BlurSigma
	The weight surrounding pixels of the processing pixel have, with further pixels in the sample block getting reduced weight. More...
BlurType	Type
	The type of Blur operation that will be performed. More...

Detailed Description

A modifier that will attempt to reduce the sharpness of the texture.

Definition at line 82 of file blurmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::BlurModifier::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 137 of file blurmodifier.cpp.

void Mezzanine::Graphics::Procedural::BlurModifier::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 93 of file blurmodifier.cpp.

BlurModifier & Mezzanine::Graphics::Procedural::BlurModifier::SetBlockSize

(

const UInt8

Size

)

Sets the sample size for each pixel to be processed.

Note

This value is only used if BT_Gaussian is set as the blur type.

Parameters

Size	The size of the block of pixels around each pixel to be processed that will be sampled. Generally this value should be around in the range of 1 to 5. Initial Value: 5.

Returns

Returns a reference to this.

Definition at line 149 of file blurmodifier.cpp.

BlurModifier & Mezzanine::Graphics::Procedural::BlurModifier::SetBlurType

(

const BlurType

Blur

)

Sets the type of bluring operation to be used.

Parameters

Blur	The type of bluring operation that will be performed.

Returns

Returns a reference to this.

Definition at line 143 of file blurmodifier.cpp.

BlurModifier & Mezzanine::Graphics::Procedural::BlurModifier::SetSigma

(

const UInt8

Sigma

)

Sets the sigma for each each pixel to be processed.

Note

This value is only used if BT_Gaussian is set as the blur type.

Parameters

Sigma

The weight surrounding pixels of the processing pixel have, with further pixels in the sample block getting reduced weight. Initial Value: 92.

Returns

Returns a reference to this.

Definition at line 155 of file blurmodifier.cpp.

Member Data Documentation

UInt8 Mezzanine::Graphics::Procedural::BlurModifier::BlurBlockSize

protected

The size of the block of pixels around each pixel to be processed that will be sampled.

Definition at line 98 of file blurmodifier.h.

UInt8 Mezzanine::Graphics::Procedural::BlurModifier::BlurSigma

protected

The weight surrounding pixels of the processing pixel have, with further pixels in the sample block getting reduced weight.

Definition at line 101 of file blurmodifier.h.

BlurType Mezzanine::Graphics::Procedural::BlurModifier::Type

protected

The type of Blur operation that will be performed.

Definition at line 95 of file blurmodifier.h.

---

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

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