Creates an image to be modified from a pre-existing image on disk. More...

#include <imagegenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::ImageGenerator:

Collaboration diagram for Mezzanine::Graphics::Procedural::ImageGenerator:

Public Member Functions
	ImageGenerator ()
	Class constructor.

virtual	~ImageGenerator ()
	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...

ImageGenerator &	SetImage (Image *ToGenerate)
	Sets the image to copy into the TextureBuffer. 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
Image *	GenImage
	A pointer to the image to copy into a TextureBuffer. More...

Detailed Description

Creates an image to be modified from a pre-existing image on disk.

Definition at line 83 of file imagegenerator.h.

Member Function Documentation

void Mezzanine::Graphics::Procedural::ImageGenerator::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.

Exceptions

If	the generated buffer is too small to fit the specified image then a PARAMETERS_EXCEPTION will be thrown. If an image has not been set then an INVALID_STATE_EXCEPTION will be thrown.

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

Definition at line 92 of file imagegenerator.cpp.

String Mezzanine::Graphics::Procedural::ImageGenerator::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 111 of file imagegenerator.cpp.

ImageGenerator & Mezzanine::Graphics::Procedural::ImageGenerator::SetImage ( Image * ToGenerate )

Sets the image to copy into the TextureBuffer.

Parameters

ToGenerate The image to be copied into a texture buffer.

Returns: Returns a reference to this.

Definition at line 117 of file imagegenerator.cpp.

Member Data Documentation

Image* Mezzanine::Graphics::Procedural::ImageGenerator::GenImage

protected

A pointer to the image to copy into a TextureBuffer.

Definition at line 88 of file imagegenerator.h.

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

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

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation