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

Creates a textile structured image. More...

#include <textilegenerator.h>

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

Public Member Functions

 TextileGenerator ()
 Class constructor.
 
virtual ~TextileGenerator ()
 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...
 
TextileGeneratorSetColour (const ColourValue &Colour)
 Sets the colour of the background. More...
 
TextileGeneratorSetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
 Set the colour of the background. More...
 
TextileGeneratorSetSeed (const Whole Seed)
 Sets the seed for the "random" number generator. 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...
 
ImageGenerateImage (const Whole SquareSize, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
 Generates the Image. More...
 
ImageGenerateImage (const Whole TexWidth, const Whole TexHeight, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
 Generates the Image. More...
 
TextureGenerateTexture (const Whole SquareSize, const String &TexName, const String &TexGroup, const Graphics::PixelFormat Format=Graphics::PF_R8G8B8A8) const
 Generates the Texture. More...
 
TextureGenerateTexture (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

ColourValue GenColour
 The background colour of the textile to be generated. More...
 
Whole GenSeed
 The seed to be used for the random number generator. More...
 

Detailed Description

Creates a textile structured image.

Creates a textile structure from a specified perlin noise on a coloured background.

Definition at line 82 of file textilegenerator.h.

Member Function Documentation

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

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

Parameters
BufferThe buffer to place this generators pixels in.

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

Definition at line 93 of file textilegenerator.cpp.

String Mezzanine::Graphics::Procedural::TextileGenerator::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 118 of file textilegenerator.cpp.

TextileGenerator & Mezzanine::Graphics::Procedural::TextileGenerator::SetColour ( const ColourValue Colour)

Sets the colour of the background.

Parameters
ColourThe colour to be applied to the textile to be generated.
Returns
Returns a reference to this.

Definition at line 124 of file textilegenerator.cpp.

TextileGenerator & Mezzanine::Graphics::Procedural::TextileGenerator::SetColour ( const Real  Red,
const Real  Green,
const Real  Blue,
const Real  Alpha = 1.0 
)

Set the colour of the background.

Parameters
RedThe Red component for the background colour. Range: [0.0, 1.0].
GreenThe Green component for the background colour. Range: [0.0, 1.0].
BlueThe Blue component for the background colour. Range: [0.0, 1.0].
AlphaThe Alpha component for the background colour. Range: [0.0, 1.0].
Returns
Returns a reference to this.

Definition at line 130 of file textilegenerator.cpp.

TextileGenerator & Mezzanine::Graphics::Procedural::TextileGenerator::SetSeed ( const Whole  Seed)

Sets the seed for the "random" number generator.

Parameters
SeedThe seed value for the random number generator. Initial Value: 5120.
Returns
Returns a reference to this.

Definition at line 136 of file textilegenerator.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::TextileGenerator::GenColour
protected

The background colour of the textile to be generated.

Definition at line 87 of file textilegenerator.h.

Whole Mezzanine::Graphics::Procedural::TextileGenerator::GenSeed
protected

The seed to be used for the random number generator.

Definition at line 90 of file textilegenerator.h.


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