Mezzanine::Graphics::Procedural::FlipModifier Class Reference

A modifier that will flip pixels along an axis or axes in a texture. More...

#include <flipmodifier.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::FlipModifier:

Collaboration diagram for Mezzanine::Graphics::Procedural::FlipModifier:

Public Types
enum	PixelFlipAxis { PFA_Horizontal = 0, PFA_Vertical = 1, PFA_Point = 2 }
	An enum used to describe which axis (or both) to flip pixels along. More...

Public Member Functions
	FlipModifier ()
	Blank constructor.
virtual	~FlipModifier ()
	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...
FlipModifier &	SetFlipAxis (const PixelFlipAxis Axis)
	Sets the axis or axes on which each pixel will be flipped. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
	TextureModifier ()
	Blank constructor.
virtual	~TextureModifier ()
	Class destructor.

Protected Attributes
PixelFlipAxis	FlipAxis
	The axis to flip each pixel of the modified image on. More...

Detailed Description

A modifier that will flip pixels along an axis or axes in a texture.

Definition at line 82 of file flipmodifier.h.

Member Enumeration Documentation

enum Mezzanine::Graphics::Procedural::FlipModifier::PixelFlipAxis

An enum used to describe which axis (or both) to flip pixels along.

Enumerator
PFA_Horizontal	Flips pixels along a horizontal dividing line.
PFA_Vertical	Flips pixels along a vertical dividing line.
PFA_Point	Flips pixels around the middle of the image.

Definition at line 86 of file flipmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::FlipModifier::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 119 of file flipmodifier.cpp.

void Mezzanine::Graphics::Procedural::FlipModifier::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 88 of file flipmodifier.cpp.

FlipModifier & Mezzanine::Graphics::Procedural::FlipModifier::SetFlipAxis

(

const PixelFlipAxis

Axis

)

Sets the axis or axes on which each pixel will be flipped.

Parameters

Axis	The axis to flip each pixel of the modified image on.

Returns

Returns a reference to this.

Definition at line 125 of file flipmodifier.cpp.

Member Data Documentation

PixelFlipAxis Mezzanine::Graphics::Procedural::FlipModifier::FlipAxis

protected

The axis to flip each pixel of the modified image on.

Definition at line 95 of file flipmodifier.h.

---

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

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