#include <ParticlePlugin.hpp>

Inheritance diagram for castor3d::ParticlePlugin:

[legend]

Collaboration diagram for castor3d::ParticlePlugin:

[legend]

Public Member Functions
C3D_API	ParticlePlugin (castor::DynamicLibraryUPtr library, Engine *engine)
	Constructor.

C3D_API	~ParticlePlugin () noexcept override
	Destructor.

Public Member Functions inherited from castor3d::Plugin
virtual C3D_API	~Plugin () noexcept=default
	Destructor.

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

C3D_API castor::String	getName () const
	Retrieves the plug-in name.

PluginType	getType () const
	Retrieves the plug-in type.

Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

Additional Inherited Members
Public Types inherited from castor3d::Plugin
using	OnLoadFunction = void ( * )( Engine , Plugin )
	< Signature for the plug-in's loading function

using	OnUnloadFunction = void ( * )( Engine * )noexcept
	Signature for the plug-in's type retrieval function.

using	GetTypeFunction = void ( * )( PluginType * )
	Signature for the plug-in's version checking function.

using	GetRequiredVersionFunction = void ( * )( Version * version )
	Signature for the plug-in's name retrieval function.

using	GetNameFunction = void ( * )( char const ** )

Protected Member Functions inherited from castor3d::Plugin
C3D_API	Plugin (PluginType type, castor::DynamicLibraryUPtr library, Engine &engine)
	Constructor.

void	load ()
	Calls load function for the plug-in.

void	unload () const noexcept
	Calls unload function for the plug-in.

Protected Member Functions inherited from castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructor.

Protected Attributes inherited from castor3d::Plugin
castor::DynamicLibraryUPtr	m_library {}

GetRequiredVersionFunction	m_pfnGetRequiredVersion {}

GetNameFunction	m_pfnGetName {}

OnLoadFunction	m_pfnOnLoad {}

OnUnloadFunction	m_pfnOnUnload {}

PluginType	m_type {}

Constructor & Destructor Documentation

◆ ParticlePlugin()

C3D_API castor3d::ParticlePlugin::ParticlePlugin	(	castor::DynamicLibraryUPtr	library,
		Engine *	engine )

Constructor.

Parameters

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

C3D_API castor3d::ParticlePlugin::~ParticlePlugin ( )

overridenoexcept

Destructor.

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