Mezzanine::Graphics::Procedural::OilPaintModifier Class Reference

A modifier that will group similiar pixels together and normalize their colour. More...

#include <oilpaintmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::OilPaintModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::OilPaintModifier:

Public Member Functions
	OilPaintModifier ()
	Blank constructor.
virtual	~OilPaintModifier ()
	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...
OilPaintModifier &	SetIntensityLevels (const Real Intensity)
	Sets the allowed range of intensity levels to be used. More...
OilPaintModifier &	SetRadius (const UInt8 SampleRadius)
	Sets the sample size for each processed pixel. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
Real	IntensityLevels
	The range of allowed intensity levels to be allowed during processing. More...
UInt8	Radius
	The radius of pixels to sample for each pixel processed. More...

Detailed Description

A modifier that will group similiar pixels together and normalize their colour.

Definition at line 82 of file oilpaintmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::OilPaintModifier::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 149 of file oilpaintmodifier.cpp.

void Mezzanine::Graphics::Procedural::OilPaintModifier::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 oilpaintmodifier.cpp.

OilPaintModifier & Mezzanine::Graphics::Procedural::OilPaintModifier::SetIntensityLevels

(

const Real

Intensity

)

Sets the allowed range of intensity levels to be used.

Remarks

The "Intensity" of a pixel is the RGB values added together divided by three. This variable changes the number of unique intensities that will be considered when processing each pixel. Smaller numbers will cause a smaller range of colours on edges and in general make it look more like a oil painting. Higher values will produce a larger range of colours that will be produced so edges may look more rough.

Parameters

Intensity

The range of allowed intensity levels to be allowed during processing. Range: 5.0-255.0. Initial Value: 20.0.

Returns

Returns a reference to this.

Definition at line 155 of file oilpaintmodifier.cpp.

OilPaintModifier & Mezzanine::Graphics::Procedural::OilPaintModifier::SetRadius

(

const UInt8

SampleRadius

)

Sets the sample size for each processed pixel.

Parameters

Radius

The radius of pixels to sample for each pixel processed. Initial Value: 3.

Returns

Returns a reference to this.

Definition at line 158 of file oilpaintmodifier.cpp.

Member Data Documentation

Real Mezzanine::Graphics::Procedural::OilPaintModifier::IntensityLevels

protected

The range of allowed intensity levels to be allowed during processing.

Definition at line 87 of file oilpaintmodifier.h.

UInt8 Mezzanine::Graphics::Procedural::OilPaintModifier::Radius

protected

The radius of pixels to sample for each pixel processed.

Definition at line 90 of file oilpaintmodifier.h.

---

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

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