Castor3D::RendererPlugin Class Reference

Renderer Plugin class. More...

Inheritance diagram for Castor3D::RendererPlugin:

Collaboration diagram for Castor3D::RendererPlugin:

Public Member Functions
C3D_API	RendererPlugin (Castor::DynamicLibrarySPtr p_library, Engine *p_engine)
	Constructor. More...
virtual C3D_API	~RendererPlugin ()
	Destructor. More...
C3D_API RenderSystem *	CreateRenderSystem (Engine *p_engine)
	Creates the RenderSystem. More...
C3D_API void	DestroyRenderSystem (RenderSystem *p_renderSystem)
	Destroys the given RenderSystem. More...
C3D_API eRENDERER_TYPE	GetRendererType ()
	Retrieves the renderer type. 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...

Friends
class	PluginBase
class	Engine

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

Renderer Plugin class.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Constructor & Destructor Documentation

RendererPlugin()

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

Constructor.

Parameters

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

~RendererPlugin()

virtual C3D_API Castor3D::RendererPlugin::~RendererPlugin ( )

virtual

Destructor.

Member Function Documentation

CreateRenderSystem()

C3D_API RenderSystem* Castor3D::RendererPlugin::CreateRenderSystem

(

Engine *

p_engine

)

Creates the RenderSystem.

Parameters

[in]

p_engine

The core engine

Returns

The created RenderSystem instance

DestroyRenderSystem()

C3D_API void Castor3D::RendererPlugin::DestroyRenderSystem

(

RenderSystem *

p_renderSystem

)

Destroys the given RenderSystem.

Parameters

[in]

p_renderSystem

The RenderSystem

GetRendererType()

C3D_API eRENDERER_TYPE Castor3D::RendererPlugin::GetRendererType

(

)

Retrieves the renderer type.

Returns

The type

Friends And Related Function Documentation

Engine

friend class Engine

friend

PluginBase

friend class PluginBase

friend

---

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

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