RenderEffect_wrapper Struct Reference

Inheritance diagram for RenderEffect_wrapper:

Collaboration diagram for RenderEffect_wrapper:

Public Member Functions
virtual int	getPassCount () const
	Return the number of passes required by this effect. More...
virtual void	performPostRenderFunctions ()
	Function called after RenderingWindow::draw is called. This is intended to be used for any required cleanup / state restoration. This function is called once only, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect. More...
virtual void	performPreRenderFunctions (int const pass)
	Function called prior to RenderingWindow::draw being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect. More...
virtual bool	realiseGeometry (::CEGUI::RenderingWindow &window,::CEGUI::GeometryBuffer &geometry)
virtual bool	update (float const elapsed,::CEGUI::RenderingWindow &window)
Public Member Functions inherited from CEGUI::RenderEffect
virtual bool	realiseGeometry (RenderingWindow &window, GeometryBuffer &geometry)=0
	Function called to generate geometry for the RenderingWindow. More...
virtual bool	update (const float elapsed, RenderingWindow &window)=0
	Function called to perform any time based updates on the RenderEffect state. More...
virtual bool	realiseGeometry (RenderingWindow &window, GeometryBuffer &geometry)=0
	Function called to generate geometry for the RenderingWindow. More...
virtual bool	update (const float elapsed, RenderingWindow &window)=0
	Function called to perform any time based updates on the RenderEffect state. More...

Member Function Documentation

virtual int RenderEffect_wrapper::getPassCount ( ) const

inlinevirtual

Return the number of passes required by this effect.

Returns

integer value indicating the number of rendering passes required to fully render this effect.

Implements CEGUI::RenderEffect.

virtual void RenderEffect_wrapper::performPostRenderFunctions ( )

inlinevirtual

Function called after RenderingWindow::draw is called. This is intended to be used for any required cleanup / state restoration. This function is called once only, unlike performPreRenderFunctions which may be called multiple times; once for each pass in the effect.

Note

Note that this function is called before any standard state cleanup that might be peformed by the Renderer module.

Implements CEGUI::RenderEffect.

virtual void RenderEffect_wrapper::performPreRenderFunctions ( int const  pass )

inlinevirtual

Function called prior to RenderingWindow::draw being called. This is intended to be used for any required setup / state initialisation and is called once for each pass in the effect.

Parameters

pass	Indicates the pass number to be initialised (starting at pass 0).

Note

Note that this function is called after any standard state initialisation that might be peformed by the Renderer module.

Implements CEGUI::RenderEffect.

References CEGUI::RenderEffect::getPassCount(), CEGUI::RenderEffect::performPostRenderFunctions(), CEGUI::RenderEffect::performPreRenderFunctions(), CEGUI::RenderEffect::realiseGeometry(), and CEGUI::RenderEffect::update().