Mezzanine::Graphics::Procedural::TextureGenerator Class Reference

A base class for texture generators that use the TextureBuffer class. More...

#include <texturegenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::TextureGenerator:

Public Member Functions
	TextureGenerator ()
	Blank constructor.
virtual	~TextureGenerator ()
	Class destructor.
virtual void	AddToTextureBuffer (TextureBuffer &Buffer) const =0
	Replaces and populates the pixels as configured in this generator to a TextureBuffer. More...
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...
virtual String	GetName () const =0
	Gets the name of this generator. More...

Detailed Description

A base class for texture generators that use the TextureBuffer class.

Definition at line 83 of file texturegenerator.h.

Member Function Documentation

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

pure virtual

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

Parameters

Buffer

The buffer to place this generators pixels in.

Implemented in Mezzanine::Graphics::Procedural::CellGenerator, Mezzanine::Graphics::Procedural::NoiseGenerator, Mezzanine::Graphics::Procedural::WoodGenerator, Mezzanine::Graphics::Procedural::GradientGenerator, Mezzanine::Graphics::Procedural::LerpGenerator, Mezzanine::Graphics::Procedural::MarbleGenerator, Mezzanine::Graphics::Procedural::CloudGenerator, Mezzanine::Graphics::Procedural::ImageGenerator, Mezzanine::Graphics::Procedural::LabyrinthGenerator, Mezzanine::Graphics::Procedural::TextileGenerator, Mezzanine::Graphics::Procedural::SolidGenerator, and Mezzanine::Graphics::Procedural::AtlasGenerator.

TextureBuffer Mezzanine::Graphics::Procedural::TextureGenerator::BuildTextureBuffer

(

const Whole

SquareSize

)

const

Creates a TextureBuffer with the pixels as configured in this generator.

Parameters

SquareSize

The width and height of the Texture to create. This value will be clamped to be at least 8.

Returns

Returns a new TextureBuffer with the generated pixels of this generator.

Definition at line 119 of file texturegenerator.cpp.

TextureBuffer Mezzanine::Graphics::Procedural::TextureGenerator::BuildTextureBuffer	(	const Whole	TexWidth,
		const Whole	TexHeight
	)		const

Creates a TextureBuffer with the pixels as configured in this generator.

Parameters

TexWidth	The pixel width of the Texture to be generated. This value will be clamped to be at least 8.
TexHeight	The pixel height of the Texture to be generated. This value will be clamped to be at least 8.

Returns

Returns a new TextureBuffer with the generated pixels of this generator.

Definition at line 126 of file texturegenerator.cpp.

Image * Mezzanine::Graphics::Procedural::TextureGenerator::GenerateImage	(	const Whole	SquareSize,
		const Graphics::PixelFormat	Format = Graphics::PF_R8G8B8A8
	)		const

Generates the Image.

Remarks

The generated image is not owned by this generator or anything. It is up to the user/caller of this method to clean it up.

Parameters

SquareSize	The width and height of the Image to create. This value will be clamped to be at least 8.
Format	The pixel format for the generated Image.

Returns

Returns a pointer to the newly created Image.

Definition at line 103 of file texturegenerator.cpp.

Image * Mezzanine::Graphics::Procedural::TextureGenerator::GenerateImage	(	const Whole	TexWidth,
		const Whole	TexHeight,
		const Graphics::PixelFormat	Format = Graphics::PF_R8G8B8A8
	)		const

Generates the Image.

Remarks

The generated image is not owned by this generator or anything. It is up to the user/caller of this method to clean it up.

Parameters

TexWidth	The pixel width of the Image to be generated. This value will be clamped to be at least 8.
TexHeight	The pixel height of the Image to be generated. This value will be clamped to be at least 8.
Format	The pixel format for the generated Image.

Returns

Returns a pointer to the newly created Image.

Definition at line 111 of file texturegenerator.cpp.

Texture * Mezzanine::Graphics::Procedural::TextureGenerator::GenerateTexture	(	const Whole	SquareSize,
		const String &	TexName,
		const String &	TexGroup,
		const Graphics::PixelFormat	Format = Graphics::PF_R8G8B8A8
	)		const

Generates the Texture.

Parameters

SquareSize	The width and height of the Texture to create. This value will be clamped to be at least 8.
TexName	The name to give to the generated Texture.
TexGroup	The asset group to place the Texture in.
Format	The pixel format for the generated Texture.

Returns

Returns a pointer to the newly created Texture.

Definition at line 87 of file texturegenerator.cpp.

Texture * Mezzanine::Graphics::Procedural::TextureGenerator::GenerateTexture	(	const Whole	TexWidth,
		const Whole	TexHeight,
		const String &	TexName,
		const String &	TexGroup,
		const Graphics::PixelFormat	Format = Graphics::PF_R8G8B8A8
	)		const

Generates the Texture.

Parameters

TexWidth	The pixel width of the Texture to be generated. This value will be clamped to be at least 8.
TexHeight	The pixel height of the Texture to be generated. This value will be clamped to be at least 8.
TexName	The name to give to the generated Texture.
TexGroup	The asset group to place the Texture in.
Format	The pixel format for the generated Texture.

Returns

Returns a pointer to the newly created Texture.

Definition at line 95 of file texturegenerator.cpp.

virtual String Mezzanine::Graphics::Procedural::TextureGenerator::GetName ( ) const

pure virtual

Gets the name of this generator.

Returns

Returns a String containing the name of this generator.

Implemented in Mezzanine::Graphics::Procedural::CellGenerator, Mezzanine::Graphics::Procedural::NoiseGenerator, Mezzanine::Graphics::Procedural::WoodGenerator, Mezzanine::Graphics::Procedural::GradientGenerator, Mezzanine::Graphics::Procedural::LerpGenerator, Mezzanine::Graphics::Procedural::MarbleGenerator, Mezzanine::Graphics::Procedural::CloudGenerator, Mezzanine::Graphics::Procedural::ImageGenerator, Mezzanine::Graphics::Procedural::LabyrinthGenerator, Mezzanine::Graphics::Procedural::TextileGenerator, Mezzanine::Graphics::Procedural::SolidGenerator, and Mezzanine::Graphics::Procedural::AtlasGenerator.

---

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

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