Mezzanine::Graphics::Procedural::SharpenModifier Class Reference

A modifier that will attempt to add detail to a texture. More...

#include <sharpenmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::SharpenModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::SharpenModifier:

Public Types
enum	SharpenType { ST_Normal = 0, ST_Gaussian = 1 }
	An enum used to describe the type of sharpening operation to be performed. More...

Public Member Functions
	SharpenModifier ()
	Blank constructor.
virtual	~SharpenModifier ()
	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...
SharpenModifier &	SetBlockSize (const UInt8 Size)
	Sets the sample size for each pixel to be processed. More...
SharpenModifier &	SetSharpenType (const SharpenType Sharpen)
	Sets the type of sharpening operation to be used. More...
SharpenModifier &	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	SharpenBlockSize
	The size of the block of pixels around each pixel to be processed that will be sampled. More...
UInt8	SharpenSigma
	The weight surrounding pixels of the processing pixel have, with further pixels in the sample block getting reduced weight. More...
SharpenType	Type
	The type of Sharpening operation that will be performed. More...

Detailed Description

A modifier that will attempt to add detail to a texture.

Definition at line 82 of file sharpenmodifier.h.

Member Enumeration Documentation

enum Mezzanine::Graphics::Procedural::SharpenModifier::SharpenType

An enum used to describe the type of sharpening operation to be performed.

Enumerator
ST_Normal	Use a simple block filter to sharpen the image.
ST_Gaussian	Use a gaussian filter to sharpen the image.

Definition at line 86 of file sharpenmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::SharpenModifier::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 145 of file sharpenmodifier.cpp.

void Mezzanine::Graphics::Procedural::SharpenModifier::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 sharpenmodifier.cpp.

SharpenModifier & Mezzanine::Graphics::Procedural::SharpenModifier::SetBlockSize

(

const UInt8

Size

)

Sets the sample size for each pixel to be processed.

Note

This value is only used if ST_Gaussian is set as the sharpen 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 154 of file sharpenmodifier.cpp.

SharpenModifier & Mezzanine::Graphics::Procedural::SharpenModifier::SetSharpenType

(

const SharpenType

Sharpen

)

Sets the type of sharpening operation to be used.

Parameters

Sharpen

The type of Sharpening operation that will be performed.

Returns

Returns a reference to this.

Definition at line 151 of file sharpenmodifier.cpp.

SharpenModifier & Mezzanine::Graphics::Procedural::SharpenModifier::SetSigma

(

const UInt8

Sigma

)

Sets the sigma for each each pixel to be processed.

Note

This value is only used if ST_Gaussian is set as the sharpen 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 157 of file sharpenmodifier.cpp.

Member Data Documentation

UInt8 Mezzanine::Graphics::Procedural::SharpenModifier::SharpenBlockSize

protected

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

Definition at line 97 of file sharpenmodifier.h.

UInt8 Mezzanine::Graphics::Procedural::SharpenModifier::SharpenSigma

protected

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

Definition at line 100 of file sharpenmodifier.h.

SharpenType Mezzanine::Graphics::Procedural::SharpenModifier::Type

protected

The type of Sharpening operation that will be performed.

Definition at line 94 of file sharpenmodifier.h.

---

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

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