Castor3D  ..
Public Member Functions | Friends | List of all members
Castor3D::GenericPlugin Class Reference

Generic Plugin class. More...

+ Inheritance diagram for Castor3D::GenericPlugin:
+ Collaboration diagram for Castor3D::GenericPlugin:

Public Member Functions

C3D_API GenericPlugin (Castor::DynamicLibrarySPtr p_library, Engine *p_engine)
 Constructor. More...
 
virtual C3D_API ~GenericPlugin ()
 Destructor. 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

Generic Plugin class.

Author
Sylvain DOREMUS
Version
0.8.0
Date
21/09/2015
Remarks
Allows general specialisations for Castor3D.

Constructor & Destructor Documentation

◆ GenericPlugin()

C3D_API Castor3D::GenericPlugin::GenericPlugin ( Castor::DynamicLibrarySPtr  p_library,
Engine p_engine 
)

Constructor.

Parameters
[in]p_libraryThe shared library holding the plug-in
[in]p_engineThe engine

◆ ~GenericPlugin()

virtual C3D_API Castor3D::GenericPlugin::~GenericPlugin ( )
virtual

Destructor.

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: