Castor3D::PostEffect Class Reference

Post render effect base class. More...

Collaboration diagram for Castor3D::PostEffect:

Public Member Functions
C3D_API	PostEffect (RenderSystem *p_renderSystem, RenderTarget &p_renderTarget, Parameters const &p_params)
	Constructor. More...
virtual C3D_API	~PostEffect ()
	Destructor. More...
virtual C3D_API bool	Initialise ()=0
	Initialisation function. More...
virtual C3D_API void	Cleanup ()=0
	Cleanup function. More...
virtual C3D_API bool	Apply (FrameBuffer &p_framebuffer)=0
	Render function, applies the effect to the given framebuffer. More...

Protected Attributes
RenderSystem *	m_renderSystem
	The render system. More...
RenderTarget &	m_renderTarget
	The render target to which this effect is attached. More...

Detailed Description

Post render effect base class.

Author

Sylvain DOREMUS

Version

0.7.0.0

Date

20/11/2012

Remarks

A post render effect is an effect applied after 3D rendering and before 2D rendering.
Post render effects are applied in a cumulative way.

Constructor & Destructor Documentation

PostEffect()

C3D_API Castor3D::PostEffect::PostEffect	(	RenderSystem *	p_renderSystem,
		RenderTarget &	p_renderTarget,
		Parameters const &	p_params
	)

Constructor.

Parameters

[in]	p_renderSystem	The render system.
[in]	p_renderTarget	The render target to which is attached this effect.
[in]	p_params	The optional parameters.

~PostEffect()

virtual C3D_API Castor3D::PostEffect::~PostEffect ( )

virtual

Destructor.

Member Function Documentation

Apply()

virtual C3D_API bool Castor3D::PostEffect::Apply ( FrameBuffer &  p_framebuffer )

pure virtual

Render function, applies the effect to the given framebuffer.

Parameters

[in,out]

p_framebuffer

The framebuffer.

Returns

true if ok.

Cleanup()

virtual C3D_API void Castor3D::PostEffect::Cleanup ( )

pure virtual

Cleanup function.

Initialise()

virtual C3D_API bool Castor3D::PostEffect::Initialise ( )

pure virtual

Initialisation function.

Returns

true if ok.

Member Data Documentation

m_renderSystem

RenderSystem* Castor3D::PostEffect::m_renderSystem

protected

The render system.

m_renderTarget

RenderTarget& Castor3D::PostEffect::m_renderTarget

protected

The render target to which this effect is attached.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/PostEffect.hpp