Ogre Procedural  0.3.0 unstable
Procedural Geometry & Textures for Ogre3D
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Procedural::Glow Class Reference

Render a glow. More...

#include <ProceduralTextureModifiers.h>

Inheritance diagram for Procedural::Glow:
Inheritance graph
[legend]

Public Member Functions

 Glow (TextureBufferPtr pBuffer)
 Default constructor. More...
 
GlowsetColour (Ogre::ColourValue colour)
 Set the colour of the glow ellipse. More...
 
GlowsetColour (Ogre::Real red, Ogre::Real green, Ogre::Real blue, Ogre::Real alpha=1.0f)
 Set the colour of the glow ellipse. More...
 
GlowsetCenterX (Ogre::Real centerx)
 Set the relative center position of the blur circle on x axis. More...
 
GlowsetCenterY (Ogre::Real centery)
 Set the relative center position of the blur circle on y axis. More...
 
GlowsetRadiusX (Ogre::Real radiusx)
 Set the relative radius of the blur circle in x direction. More...
 
GlowsetRadiusY (Ogre::Real radiusy)
 Set the relative radius of the blur circle in y direction. More...
 
GlowsetAlpha (Ogre::Real alpha)
 Set alpha value of blur effect. More...
 
GlowsetGamma (Ogre::Real gamma)
 Set gamma value of blur effect. More...
 
TextureBufferPtr process ()
 Run image manipulation. More...
 
Ogre::String getName ()
 Get name of the filter as string. More...
 
void setLog (bool enable=true)
 Enable/Disable logging. More...
 

Protected Member Functions

void logMsg (Ogre::String msg)
 

Protected Attributes

TextureBufferPtr mBuffer
 
Ogre::String mName
 
bool mLog
 

Detailed Description

Render a glow.

Glow is a blurred, filled ellipse of given color, that is added to existing content.

Example:

Procedural::TextureBuffer bufferGradient(256);
Procedural::Gradient(&bufferGradient).process();
Procedural::Glow(&bufferGradient).process();

dot_texture_15.png

Constructor & Destructor Documentation

◆ Glow()

Procedural::Glow::Glow ( TextureBufferPtr  pBuffer)

Default constructor.

Parameters
pBufferImage buffer where to modify the image.

Member Function Documentation

◆ getName()

Ogre::String Procedural::TextureProcessing::getName ( )
inherited

Get name of the filter as string.

◆ logMsg()

void Procedural::TextureProcessing::logMsg ( Ogre::String  msg)
protectedinherited

◆ process()

TextureBufferPtr Procedural::Glow::process ( )
virtual

Run image manipulation.

Returns
Pointer to image buffer which has been set in the constructor.

Implements Procedural::TextureProcessing.

◆ setAlpha()

Glow& Procedural::Glow::setAlpha ( Ogre::Real  alpha)

Set alpha value of blur effect.

Parameters
alphaNew alpha value for blur effect (default 1)

◆ setCenterX()

Glow& Procedural::Glow::setCenterX ( Ogre::Real  centerx)

Set the relative center position of the blur circle on x axis.

Parameters
centerxNew relative center of the blur circle [0.0, 1.0] (default 0.5)

◆ setCenterY()

Glow& Procedural::Glow::setCenterY ( Ogre::Real  centery)

Set the relative center position of the blur circle on y axis.

Parameters
centeryNew relative center of the blur circle [0.0, 1.0] (default 0.5)

◆ setColour() [1/2]

Glow& Procedural::Glow::setColour ( Ogre::ColourValue  colour)

Set the colour of the glow ellipse.

Parameters
colourNew colour for glow ellipse (default Ogre::ColourValue::White)

◆ setColour() [2/2]

Glow& Procedural::Glow::setColour ( Ogre::Real  red,
Ogre::Real  green,
Ogre::Real  blue,
Ogre::Real  alpha = 1.0f 
)

Set the colour of the glow ellipse.

Parameters
redRed value of the glow ellipse [0.0, 1.0] (default 1.0)
greenGreen value of the glow ellipse [0.0, 1.0] (default 1.0)
blueBlue value of the glow ellipse [0.0, 1.0] (default 1.0)
alphaAlpha value of the glow ellipse [0.0, 1.0] (default 1.0)

◆ setGamma()

Glow& Procedural::Glow::setGamma ( Ogre::Real  gamma)

Set gamma value of blur effect.

Parameters
gammaNew gamma value for blur effect (default 1)

◆ setLog()

void Procedural::TextureProcessing::setLog ( bool  enable = true)
inherited

Enable/Disable logging.

Parameters
enabletrue enables logging of filter actions

◆ setRadiusX()

Glow& Procedural::Glow::setRadiusX ( Ogre::Real  radiusx)

Set the relative radius of the blur circle in x direction.

Parameters
radiusxNew relative radius of the blur circle [0.0, 1.0] (default 0.5)

◆ setRadiusY()

Glow& Procedural::Glow::setRadiusY ( Ogre::Real  radiusy)

Set the relative radius of the blur circle in y direction.

Parameters
radiusyNew relative radius of the blur circle [0.0, 1.0] (default 0.5)

Member Data Documentation

◆ mBuffer

TextureBufferPtr Procedural::TextureProcessing::mBuffer
protectedinherited

◆ mLog

bool Procedural::TextureProcessing::mLog
protectedinherited

◆ mName

Ogre::String Procedural::TextureProcessing::mName
protectedinherited

The documentation for this class was generated from the following file:
Procedural::Gradient::process
TextureBufferPtr process()
Run image generation.
Procedural::Glow
Render a glow.
Definition: ProceduralTextureModifiers.h:1605
Procedural::Gradient
Fills full image with given colour gradients.
Definition: ProceduralTextureGenerator.h:229
Procedural::Glow::process
TextureBufferPtr process()
Run image manipulation.
Procedural::TextureBuffer
class to store image data while processing
Definition: ProceduralTextureBuffer.h:50