vl::ShaderAnimator Class Reference

Callback object used to update/animate a Shader during the rendering. More...

#include <Shader.hpp>

Inheritance diagram for vl::ShaderAnimator:

Public Member Functions
	ShaderAnimator ()
virtual void	updateShader (Shader *shader, Camera *camera, real cur_time)=0
	Reimplement this function to update/animate a Shader. More...
void	setEnabled (bool enable)
	Whether the ShaderAnimator is enabled or not. More...
bool	isEnabled () const
	Whether the ShaderAnimator is enabled or not. More...
Public Member Functions inherited from vl::Object
	Object ()
	Constructor. More...
	Object (const Object &other)
	Copy constructor: copies the name, ref count mutex and user data. More...
Object &	operator= (const Object &other)
	Copy operator: copies the object's name, ref count mutex and user data. More...
const std::string &	objectName () const
	The name of the object, by default set to the object's class name. More...
void	setObjectName (const char *name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setObjectName (const std::string &name)
	The name of the object, by default set to the object's class name in debug builds. More...
void	setRefCountMutex (IMutex *mutex)
	The mutex used to protect the reference counting of an Object across multiple threads. More...
IMutex *	refCountMutex ()
	The mutex used to protect the reference counting of an Object across multiple threads. More...
const IMutex *	refCountMutex () const
	The mutex used to protect the reference counting of an Object across multiple threads. More...
int	referenceCount () const
	Returns the number of references of an object. More...
void	incReference () const
	Increments the reference count of an object. More...
void	decReference ()
	Decrements the reference count of an object and deletes it if both automaticDelete() is true the count reaches 0. More...
void	setAutomaticDelete (bool autodel_on)
	If set to true the Object is deleted when its reference count reaches 0. More...
bool	automaticDelete () const
	If set to true the Object is deleted when its reference count reaches 0. More...
template<class T >
T *	as ()
	Casts an Object to the specified class. More...
template<class T >
const T *	as () const
	Casts an Object to the specified class. More...

Protected Attributes
bool	mEnabled
Protected Attributes inherited from vl::Object
std::string	mObjectName
IMutex *	mRefCountMutex
int	mReferenceCount
bool	mAutomaticDelete

Additional Inherited Members
Protected Member Functions inherited from vl::Object
virtual	~Object ()

Detailed Description

Callback object used to update/animate a Shader during the rendering.

The updateShader() method will be called whenever a visible object uses the Shader to which the ShaderAnimator is bound.

See also

Shader::setUpdater();

Definition at line 1792 of file Shader.hpp.

Constructor & Destructor Documentation

ShaderAnimator()

vl::ShaderAnimator::ShaderAnimator ( )

inline

Definition at line 1797 of file Shader.hpp.

Member Function Documentation

isEnabled()

bool vl::ShaderAnimator::isEnabled ( ) const

inline

Whether the ShaderAnimator is enabled or not.

Definition at line 1810 of file Shader.hpp.

Referenced by vl::Rendering::fillRenderQueue().

setEnabled()

void vl::ShaderAnimator::setEnabled ( bool  enable )

inline

Whether the ShaderAnimator is enabled or not.

Definition at line 1807 of file Shader.hpp.

updateShader()

virtual void vl::ShaderAnimator::updateShader ( Shader *  shader, Camera *  camera, real  cur_time  )

pure virtual

Reimplement this function to update/animate a Shader.

Parameters

shader	the Shader to be updated.
camera	the camera used for the current rendering.
cur_time	the current animation time.

See also

Shader::setShaderAnimator();

Referenced by vl::Rendering::fillRenderQueue().

Member Data Documentation

mEnabled

bool vl::ShaderAnimator::mEnabled

protected

Definition at line 1813 of file Shader.hpp.

---

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

• C:/git/VL/src/vlGraphics/Shader.hpp