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

#include <FrameListener.hpp>

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

Graphe de collaboration de castor3d::FrameListener:

Fonctions membres publiques
C3D_API	FrameListener (castor::String const &name)
	Constructeur.
virtual C3D_API	~FrameListener () noexcept
	Destructeur.
C3D_API void	flush ()
	Vide les listes d'évènements.
C3D_API CpuFrameEvent *	postEvent (CpuFrameEventUPtr event)
	Ajoute un évènement à la liste d'évènements correspondant à sont type.
C3D_API GpuFrameEvent *	postEvent (GpuFrameEventUPtr event)
	Ajoute un évènement à la liste d'évènements correspondant à sont type.
C3D_API bool	fireEvents (CpuEventType type)
	Traite tous les évènements d'un type donné.
C3D_API bool	fireEvents (GpuEventType type, RenderDevice const &device, QueueData const &queueData)
	Traite tous les évènements d'un type donné.
C3D_API void	flushEvents (CpuEventType type)
	Supprime tous les évènements d'un type donné.
C3D_API void	flushEvents (GpuEventType type)
	Supprime tous les évènements d'un type donné.
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Fonctions membres protégées
virtual C3D_API void	doFlush ()
	Vide les listes d'évènements.

Attributs protégés
castor::Array< CpuFrameEventPtrArray, size_t(CpuEventType::eCount) >	m_cpuEvents
castor::Array< GpuFrameEventPtrArray, size_t(GpuEventType::eCount) >	m_gpuEvents
castor::RecursiveMutex	m_mutex
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des constructeurs et destructeur

FrameListener()

C3D_API castor3d::FrameListener::FrameListener ( castor::String const & name )

explicit

Constructeur.

Paramètres

[in]

name

Le nom du listener.

~FrameListener()

virtual C3D_API castor3d::FrameListener::~FrameListener ( )

virtualnoexcept

Destructeur.

Documentation des fonctions membres

doFlush()

virtual C3D_API void castor3d::FrameListener::doFlush ( )

inlineprotectedvirtual

Vide les listes d'évènements.

fireEvents() [1/2]

C3D_API bool castor3d::FrameListener::fireEvents

(

CpuEventType

type

)

Traite tous les évènements d'un type donné.

Paramètres

[in]

type

Le type des évènements à traiter.

Renvoie

true if all events were processed successfully.

fireEvents() [2/2]

C3D_API bool castor3d::FrameListener::fireEvents	(	GpuEventType	type,
		RenderDevice const &	device,
		QueueData const &	queueData )

Traite tous les évènements d'un type donné.

Paramètres

[in]	type	Le type des évènements à traiter.
[in]	device	Le device GPU.
[in]	queueData	La queue recevant les commandes GPU.

Renvoie

true if all events were processed successfully.

flush()

C3D_API void castor3d::FrameListener::flush

(

)

Vide les listes d'évènements.

flushEvents() [1/2]

C3D_API void castor3d::FrameListener::flushEvents

(

CpuEventType

type

)

Supprime tous les évènements d'un type donné.

Paramètres

[in]

type

Le type des évènements à traiter.

flushEvents() [2/2]

C3D_API void castor3d::FrameListener::flushEvents

(

GpuEventType

type

)

Supprime tous les évènements d'un type donné.

Paramètres

[in]

type

Le type des évènements à traiter.

postEvent() [1/2]

C3D_API CpuFrameEvent * castor3d::FrameListener::postEvent

(

CpuFrameEventUPtr

event

)

Ajoute un évènement à la liste d'évènements correspondant à sont type.

Paramètres

[in]

event

L'évènement à ajouter.

Référencé par castor3d::CpuEventInitialiserT< CacheT >::operator()(), castor3d::CpuEventCleanerT< CacheT >::operator()(), castor3d::GpuEventInitialiserT< CacheT >::operator()(), et castor3d::GpuEventCleanerT< CacheT >::operator()().

Voici le graphe des appelants de cette fonction :

postEvent() [2/2]

C3D_API GpuFrameEvent * castor3d::FrameListener::postEvent

(

GpuFrameEventUPtr

event

)

Ajoute un évènement à la liste d'évènements correspondant à sont type.

Paramètres

[in]

event

L'évènement à ajouter.

Documentation des données membres

m_cpuEvents

castor::Array< CpuFrameEventPtrArray, size_t( CpuEventType::eCount ) > castor3d::FrameListener::m_cpuEvents

protected

Les tableaux d'évènements CPU.

m_gpuEvents

castor::Array< GpuFrameEventPtrArray, size_t( GpuEventType::eCount ) > castor3d::FrameListener::m_gpuEvents

protected

Les tableaux d'évènements GPU.

m_mutex

castor::RecursiveMutex castor3d::FrameListener::m_mutex

protected

Mutex pour rendre cette classe thread safe.

---

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

• Castor3D/Event/Frame/FrameListener.hpp