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

A modifier that will invert the value of each colour channel for each pixel. More...

#include <invertmodifier.h>

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

Public Member Functions

 InvertModifier ()
 Blank constructor.
 
virtual ~InvertModifier ()
 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...
 
InvertModifierSetIncludeAlpha (const Boole Alpha)
 Sets whether or not the Alpha channel should be included for inversion. More...
 
- Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureModifier
 TextureModifier ()
 Blank constructor.
 
virtual ~TextureModifier ()
 Class destructor.
 

Protected Attributes

Boole IncludeAlpha
 Whether or not the Alpha channel should be inverted when a texture is processed. More...
 

Detailed Description

A modifier that will invert the value of each colour channel for each pixel.

Definition at line 82 of file invertmodifier.h.

Member Function Documentation

String Mezzanine::Graphics::Procedural::InvertModifier::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 103 of file invertmodifier.cpp.

void Mezzanine::Graphics::Procedural::InvertModifier::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 invertmodifier.cpp.

InvertModifier & Mezzanine::Graphics::Procedural::InvertModifier::SetIncludeAlpha ( const Boole  Alpha)

Sets whether or not the Alpha channel should be included for inversion.

Parameters
AlphaWhether or not the Alpha channel should be inverted when a texture is processed. Initial Value: false.

Definition at line 109 of file invertmodifier.cpp.

Member Data Documentation

Boole Mezzanine::Graphics::Procedural::InvertModifier::IncludeAlpha
protected

Whether or not the Alpha channel should be inverted when a texture is processed.

Definition at line 87 of file invertmodifier.h.


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