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

#include <DebugOverlays.hpp>

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

Graphe de collaboration de castor3d::DebugOverlays:

Fonctions membres publiques
	DebugOverlays (Engine &engine)
	Constructeur.
	~DebugOverlays ()
	Destructeur.
void	initialise (OverlayCache &cache)
	Fonction d'initialisation, récupère les incrustations à partir du cache d'incrustations donné.
void	cleanup ()
	Fonction de nettoyage.
RenderInfo &	beginFrame ()
	Réinitialise tous les compteurs d'image.
castor::Microseconds	endFrame (bool first)
	Met à jour les textes des incrustations de débogage.
void	endGpuTask ()
	Utilisé pour ajouter au temps GPU le temps écoulé entre maintenant et le dernier appel de endGpuTask ou endCpuTask.
void	endCpuTask ()
	Utilisé pour ajouter au temps GPU le temps écoulé entre maintenant et le dernier appel de endGpuTask ou endCpuTask.
void	show (bool show)
	Affiche ou cache les incrustations de débogage.
void	registerTimer (castor::String const &category, FramePassTimer &timer)
	Enregistre un timer de passe de rendu.
void	unregisterTimer (castor::String const &category, FramePassTimer &timer)
	Désenregistre un timer de passe de rendu.
void	dumpFrameTimes (Parameters &params)
	Remplit les paramètres avec les temps de toutes les passes, en nanosecondes.
bool	isShown () const
castor::Nanoseconds	getAvgFrameTime () const

Documentation des constructeurs et destructeur

DebugOverlays()

castor3d::DebugOverlays::DebugOverlays ( Engine &  engine )

explicit

Constructeur.

Paramètres

[in]

engine

Le moteur.

~DebugOverlays()

castor3d::DebugOverlays::~DebugOverlays

(

)

Destructeur.

Documentation des fonctions membres

beginFrame()

RenderInfo & castor3d::DebugOverlays::beginFrame

(

)

Réinitialise tous les compteurs d'image.

Renvoie

Les informations de rendu.

cleanup()

void castor3d::DebugOverlays::cleanup

(

)

Fonction de nettoyage.

dumpFrameTimes()

void castor3d::DebugOverlays::dumpFrameTimes

(

Parameters &

params

)

Remplit les paramètres avec les temps de toutes les passes, en nanosecondes.

Paramètres

[in,out]

params

Reçoit les temps.

endCpuTask()

void castor3d::DebugOverlays::endCpuTask

(

)

Utilisé pour ajouter au temps GPU le temps écoulé entre maintenant et le dernier appel de endGpuTask ou endCpuTask.

endFrame()

castor::Microseconds castor3d::DebugOverlays::endFrame

(

bool

first

)

Met à jour les textes des incrustations de débogage.

Paramètres

[in]

first

Dit s'il s'agit du rendu de la première frame

Renvoie

Le temps écoulé pour cette frame.

endGpuTask()

void castor3d::DebugOverlays::endGpuTask

(

)

Utilisé pour ajouter au temps GPU le temps écoulé entre maintenant et le dernier appel de endGpuTask ou endCpuTask.

getAvgFrameTime()

castor::Nanoseconds castor3d::DebugOverlays::getAvgFrameTime ( ) const

inline

initialise()

void castor3d::DebugOverlays::initialise

(

OverlayCache &

cache

)

Fonction d'initialisation, récupère les incrustations à partir du cache d'incrustations donné.

Paramètres

[in]

cache

Le cache d'incrustations.

isShown()

bool castor3d::DebugOverlays::isShown ( ) const

inline

Renvoie

Le statut d'affichage des incrustations de débogage.

registerTimer()

void castor3d::DebugOverlays::registerTimer	(	castor::String const &	category,
		FramePassTimer &	timer
	)

Enregistre un timer de passe de rendu.

Paramètres

[in]	category	Le nom de la catégorie du timer.
[in]	timer	Le timer à enregistrer.

show()

void castor3d::DebugOverlays::show

(

bool

show

)

Affiche ou cache les incrustations de débogage.

Paramètres

[in]

show

Le statut.

unregisterTimer()

void castor3d::DebugOverlays::unregisterTimer	(	castor::String const &	category,
		FramePassTimer &	timer
	)

Désenregistre un timer de passe de rendu.

Paramètres

[in]	category	Le nom de la catégorie du timer.
[in]	timer	Le timer à désenregistrer.

---

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

• Overlay/DebugOverlays.hpp