Référence de la classe castor3d::Plugin

#include <Plugin.hpp>

Graphe d'héritage de castor3d::Plugin:

Graphe de collaboration de castor3d::Plugin:

Types publics
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 ** )

Fonctions membres publiques
virtual C3D_API	~Plugin () noexcept=default
	Destructeur.
C3D_API void	getRequiredVersion (Version &version) const
	Récupère la version nécessaire au bon fonctionnement du plug-in.
C3D_API castor::String	getName () const
	Récupère le nom du plug-in.
PluginType	getType () const
	Récupère le type du plug-in.
Fonctions membres publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Fonctions membres protégées
C3D_API	Plugin (PluginType type, castor::DynamicLibraryUPtr library, Engine &engine)
	Constructeur.
void	load ()
	Exécute la fonction de chargement du plug-in.
void	unload () const noexcept
	Exécute la fonction de déchargement du plug-in.
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.

Attributs protégés
castor::DynamicLibraryUPtr	m_library {}
GetRequiredVersionFunction	m_pfnGetRequiredVersion {}
GetNameFunction	m_pfnGetName {}
OnLoadFunction	m_pfnOnLoad {}
OnUnloadFunction	m_pfnOnUnload {}
PluginType	m_type {}

Documentation des définitions de type membres

GetNameFunction

using castor3d::Plugin::GetNameFunction = void ( * )( char const ** )

GetRequiredVersionFunction

using castor3d::Plugin::GetRequiredVersionFunction = void ( * )( Version * version )

Signature for the plug-in's name retrieval function.

GetTypeFunction

using castor3d::Plugin::GetTypeFunction = void ( * )( PluginType * )

Signature for the plug-in's version checking function.

OnLoadFunction

using castor3d::Plugin::OnLoadFunction = void ( * )( Engine *, Plugin * )

< Signature for the plug-in's loading function

Signature for the plug-in's unloading function

OnUnloadFunction

using castor3d::Plugin::OnUnloadFunction = void ( * )( Engine * )noexcept

Signature for the plug-in's type retrieval function.

Documentation des constructeurs et destructeur

Plugin()

C3D_API castor3d::Plugin::Plugin ( PluginType type, castor::DynamicLibraryUPtr library, Engine & engine )

protected

Constructeur.

Paramètres

[in]	type	Le type du plug-in
[in]	library	La bibliothèque partagée contenant le plug-in
[in]	engine	Le moteur

~Plugin()

virtual C3D_API castor3d::Plugin::~Plugin ( )

virtualdefaultnoexcept

Destructeur.

Documentation des fonctions membres

getName()

C3D_API castor::String castor3d::Plugin::getName

(

)

const

Récupère le nom du plug-in.

Renvoie

Le nom

getRequiredVersion()

C3D_API void castor3d::Plugin::getRequiredVersion

(

Version &

version

)

const

Récupère la version nécessaire au bon fonctionnement du plug-in.

Paramètres

[out]

version

Reçoit la version.

getType()

PluginType castor3d::Plugin::getType ( ) const

inline

Récupère le type du plug-in.

Renvoie

Le type

Références m_type.

load()

void castor3d::Plugin::load ( )

protected

Exécute la fonction de chargement du plug-in.

unload()

void castor3d::Plugin::unload ( ) const

protectednoexcept

Exécute la fonction de déchargement du plug-in.

Documentation des données membres

m_library

castor::DynamicLibraryUPtr castor3d::Plugin::m_library {}

protected

La bibliothèque du plug-in.

m_pfnGetName

GetNameFunction castor3d::Plugin::m_pfnGetName {}

protected

La fonction de récupération du nom du plug-in.

m_pfnGetRequiredVersion

GetRequiredVersionFunction castor3d::Plugin::m_pfnGetRequiredVersion {}

protected

La fonction de récupération de la version requise.

m_pfnOnLoad

OnLoadFunction castor3d::Plugin::m_pfnOnLoad {}

protected

La fonction de chargement du plug-in.

m_pfnOnUnload

OnUnloadFunction castor3d::Plugin::m_pfnOnUnload {}

protected

La fonction de déchargement du plug-in.

m_type

PluginType castor3d::Plugin::m_type {}

protected

Le type du plug-in.

Référencé par getType().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Castor3D/Plugin/Plugin.hpp