Mezzanine::Graphics::Procedural::LerpGenerator Class Reference

Creates a texture that is the interpolated result between two other textures. More...

#include <lerpgenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::LerpGenerator:

Collaboration diagram for Mezzanine::Graphics::Procedural::LerpGenerator:

Public Member Functions
	LerpGenerator ()
	Class constructor.
virtual	~LerpGenerator ()
	Class destructor.
virtual void	AddToTextureBuffer (TextureBuffer &Buffer) const
	Replaces and populates the pixels as configured in this generator to a TextureBuffer. More...
virtual String	GetName () const
	Gets the name of this generator. More...
LerpGenerator &	SetFirstTexture (TextureBuffer *First)
	The first texture to interpolate. Exceptions If the texture provided here isn't at least the same size as the texture to be generated a PARAMETERS_EXCEPTION will be thrown. More...
LerpGenerator &	SetInterpolateAmount (const Real Amount)
	Sets how much interpolation between the two textures to do. More...
LerpGenerator &	SetSecondTexture (TextureBuffer *Second)
	The second texture to interpolate. Exceptions If the texture provided here isn't at least the same size as the texture to be generated a PARAMETERS_EXCEPTION will be thrown. More...
Public Member Functions inherited from Mezzanine::Graphics::Procedural::TextureGenerator
	TextureGenerator ()
	Blank constructor.
virtual	~TextureGenerator ()
	Class destructor.
TextureBuffer	BuildTextureBuffer (const Whole SquareSize) const
	Creates a TextureBuffer with the pixels as configured in this generator. More...
TextureBuffer	BuildTextureBuffer (const Whole TexWidth, const Whole TexHeight) const
	Creates a TextureBuffer with the pixels as configured in this generator. More...
Image *	GenerateImage (const Whole SquareSize, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Image. More...
Image *	GenerateImage (const Whole TexWidth, const Whole TexHeight, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Image. More...
Texture *	GenerateTexture (const Whole SquareSize, const String &TexName, const String &TexGroup, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Texture. More...
Texture *	GenerateTexture (const Whole TexWidth, const Whole TexHeight, const String &TexName, const String &TexGroup, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
	Generates the Texture. More...

Protected Attributes
TextureBuffer *	FirstTexture
	The first texture to interpolate. More...
Real	InterpolateAmount
	The amount to interpolate each colour channel of the provided textures. More...
TextureBuffer *	SecondTexture
	The second texture to interpolate. More...

Detailed Description

Creates a texture that is the interpolated result between two other textures.

Definition at line 82 of file lerpgenerator.h.

Member Function Documentation

void Mezzanine::Graphics::Procedural::LerpGenerator::AddToTextureBuffer ( TextureBuffer &  Buffer ) const

virtual

Replaces and populates the pixels as configured in this generator to a TextureBuffer.

Parameters

Buffer

The buffer to place this generators pixels in.

Implements Mezzanine::Graphics::Procedural::TextureGenerator.

Definition at line 93 of file lerpgenerator.cpp.

String Mezzanine::Graphics::Procedural::LerpGenerator::GetName ( ) const

virtual

Gets the name of this generator.

Returns

Returns a String containing the name of this generator.

Implements Mezzanine::Graphics::Procedural::TextureGenerator.

Definition at line 125 of file lerpgenerator.cpp.

LerpGenerator & Mezzanine::Graphics::Procedural::LerpGenerator::SetFirstTexture

(

TextureBuffer *

First

)

The first texture to interpolate.

Exceptions

If	the texture provided here isn't at least the same size as the texture to be generated a PARAMETERS_EXCEPTION will be thrown.

Parameters

First

A pointer to the first texture to interpolate between. Initial Value: NULL.

Returns

Returns a reference to this.

Definition at line 131 of file lerpgenerator.cpp.

LerpGenerator & Mezzanine::Graphics::Procedural::LerpGenerator::SetInterpolateAmount

(

const Real

Amount

)

Sets how much interpolation between the two textures to do.

Parameters

Amount

The amount of interpolation to perform on each colour channel of each pixel. Must be in the range of 0-1. Initial Value: 0.5.

Returns

Returns a reference to this.

Definition at line 143 of file lerpgenerator.cpp.

LerpGenerator & Mezzanine::Graphics::Procedural::LerpGenerator::SetSecondTexture

(

TextureBuffer *

Second

)

The second texture to interpolate.

Exceptions

If	the texture provided here isn't at least the same size as the texture to be generated a PARAMETERS_EXCEPTION will be thrown.

Parameters

Second

A pointer to the second texture to interpolate between. Initial Value: NULL.

Returns

Returns a reference to this.

Definition at line 137 of file lerpgenerator.cpp.

Member Data Documentation

TextureBuffer* Mezzanine::Graphics::Procedural::LerpGenerator::FirstTexture

protected

The first texture to interpolate.

Definition at line 87 of file lerpgenerator.h.

Real Mezzanine::Graphics::Procedural::LerpGenerator::InterpolateAmount

protected

The amount to interpolate each colour channel of the provided textures.

Definition at line 93 of file lerpgenerator.h.

TextureBuffer* Mezzanine::Graphics::Procedural::LerpGenerator::SecondTexture

protected

The second texture to interpolate.

Definition at line 90 of file lerpgenerator.h.

---

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

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