Post effect plug-in class. More...

Inheritance diagram for Castor3D::PostFxPlugin:

Collaboration diagram for Castor3D::PostFxPlugin:

Public Member Functions
C3D_API	PostFxPlugin (Castor::DynamicLibrarySPtr p_library, Engine *p_engine)
	Constructor. More...

virtual C3D_API	~PostFxPlugin ()
	Destructor. More...

C3D_API PostEffectSPtr	CreateEffect (RenderSystem *p_renderSystem, RenderTarget &p_renderTarget, Parameters const &p_params)
	Creates a PostEffect object. More...

C3D_API Castor::String	GetPostEffectType ()
	Tells the effect short name. More...

Public Member Functions inherited from Castor3D::PluginBase
virtual C3D_API	~PluginBase ()=0
	Destructor. More...

C3D_API void	GetRequiredVersion (Version &p_version) const
	Retrieves the required version for the plug-in to work correctly. More...

C3D_API Castor::String	GetName () const
	Retrieves the plug-in name. More...

ePLUGIN_TYPE	GetType () const
	Retrieves the plug-in type. More...

Additional Inherited Members
Public Types inherited from Castor3D::PluginBase
typedef OnLoadFunction *	POnLoadFunction

typedef OnUnloadFunction *	POnUnloadFunction

typedef GetTypeFunction *	PGetTypeFunction

typedef GetRequiredVersionFunction *	PGetRequiredVersionFunction

typedef GetNameFunction *	PGetNameFunction

Protected Member Functions inherited from Castor3D::PluginBase
C3D_API	PluginBase (ePLUGIN_TYPE p_type, Castor::DynamicLibrarySPtr p_library, Engine &p_engine)
	Constructor. More...

Protected Attributes inherited from Castor3D::PluginBase
PGetRequiredVersionFunction	m_pfnGetRequiredVersion
	The plug-in's version checking function. More...

PGetNameFunction	m_pfnGetName
	The plug-in's name retrieval function. More...

POnLoadFunction	m_pfnOnLoad
	The plug-in's loading function. More...

POnUnloadFunction	m_pfnOnUnload
	The plug-in's unloading function. More...

ePLUGIN_TYPE	m_type
	The plug-in type. More...

Detailed Description

Post effect plug-in class.

Constructor & Destructor Documentation

C3D_API Castor3D::PostFxPlugin::PostFxPlugin	(	Castor::DynamicLibrarySPtr	p_library,
		Engine *	p_engine
	)

Constructor.

Parameters

[in]	p_library	The shared library holding the plug-in
[in]	p_engine	The engine

virtual C3D_API Castor3D::PostFxPlugin::~PostFxPlugin ( )

virtual

Destructor.

C3D_API PostEffectSPtr Castor3D::PostFxPlugin::CreateEffect	(	RenderSystem *	p_renderSystem,
		RenderTarget &	p_renderTarget,
		Parameters const &	p_params
	)

Creates a PostEffect object.

Parameters

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

C3D_API Castor::String Castor3D::PostFxPlugin::GetPostEffectType ( )

Tells the effect short name.

friend class PluginBase

friend

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