Mezzanine::Graphics::Procedural::SolidGenerator Class Reference

Fills full image with given colour. More...

#include <solidgenerator.h>

Inheritance diagram for Mezzanine::Graphics::Procedural::SolidGenerator:

Collaboration diagram for Mezzanine::Graphics::Procedural::SolidGenerator:

Public Member Functions
	SolidGenerator ()
	Class constructor.
virtual	~SolidGenerator ()
	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...
SolidGenerator &	SetColour (const ColourValue &Colour)
	Sets the colour of the background. More...
SolidGenerator &	SetColour (const Real Red, const Real Green, const Real Blue, const Real Alpha=1.0)
	Set the colour of the background. 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
ColourValue	GenColour
	The solid colour to generate. More...

Detailed Description

Fills full image with given colour.

Set all pixel to the same colour.

Definition at line 82 of file solidgenerator.h.

Member Function Documentation

void Mezzanine::Graphics::Procedural::SolidGenerator::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 88 of file solidgenerator.cpp.

String Mezzanine::Graphics::Procedural::SolidGenerator::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 99 of file solidgenerator.cpp.

SolidGenerator & Mezzanine::Graphics::Procedural::SolidGenerator::SetColour

(

const ColourValue &

Colour

)

Sets the colour of the background.

Parameters

Colour

The solid colour to be applied to each pixel.

Returns

Returns a reference to this.

Definition at line 105 of file solidgenerator.cpp.

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

Set the colour of the background.

Parameters

Red	The Red component for the background colour. Range: [0.0, 1.0].
Green	The Green component for the background colour. Range: [0.0, 1.0].
Blue	The Blue component for the background colour. Range: [0.0, 1.0].
Alpha	The Alpha component for the background colour. Range: [0.0, 1.0].

Returns

Returns a reference to this.

Definition at line 111 of file solidgenerator.cpp.

Member Data Documentation

ColourValue Mezzanine::Graphics::Procedural::SolidGenerator::GenColour

protected

The solid colour to generate.

Definition at line 87 of file solidgenerator.h.

---

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

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