castor3d::DebugOverlays Class Reference

#include <DebugOverlays.hpp>

Inheritance diagram for castor3d::DebugOverlays:

Collaboration diagram for castor3d::DebugOverlays:

Public Member Functions
	DebugOverlays (Engine &engine)
	Constructor.
void	cleanup ()
	Clean up function.
RenderInfo &	beginFrame ()
	Resets all frame counters.
castor::Microseconds	endFrame (bool first)
	Updates the overlays texts.
void	endGpuTasks ()
	Collects all GPU times.
void	endCpuTask ()
	Used to add to the GPU time, the time elapsed between now and the last call of either endGpuTask or endCpuTask.
void	show (bool show)
	Show or hide debug overlays.
void	registerTimer (castor::String const &category, FramePassTimer &timer)
	Registers a render pass timer.
void	unregisterTimer (castor::String const &category, FramePassTimer &timer)
	Unregisters a render pass timer.
void	dumpFrameTimes (Parameters &params)
	Fills the parameters with all passes times, in nanoseconds.
bool	isShown () const
castor::Nanoseconds	getAvgFrameTime () const
Public Member Functions inherited from castor::OwnedBy< Engine >
Engine *	getOwner () const

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

Constructor & Destructor Documentation

DebugOverlays()

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

explicit

Constructor.

Parameters

[in]

engine

The engine.

Member Function Documentation

beginFrame()

RenderInfo & castor3d::DebugOverlays::beginFrame

(

)

Resets all frame counters.

Returns

The render infos.

cleanup()

void castor3d::DebugOverlays::cleanup

(

)

Clean up function.

dumpFrameTimes()

void castor3d::DebugOverlays::dumpFrameTimes

(

Parameters &

params

)

Fills the parameters with all passes times, in nanoseconds.

Parameters

[in,out]

params

Receives the times.

endCpuTask()

void castor3d::DebugOverlays::endCpuTask

(

)

Used to add to the GPU time, the time elapsed between now and the last call of either endGpuTask or endCpuTask.

endFrame()

castor::Microseconds castor3d::DebugOverlays::endFrame

(

bool

first

)

Updates the overlays texts.

Parameters

[in]

first

Tells if this is the first pass.

Returns

The elapsed time for this frame.

endGpuTasks()

void castor3d::DebugOverlays::endGpuTasks

(

)

Collects all GPU times.

getAvgFrameTime()

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

inline

isShown()

bool castor3d::DebugOverlays::isShown ( ) const

inline

Returns

The debug overlays shown status.

registerTimer()

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

Registers a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to register.

show()

void castor3d::DebugOverlays::show

(

bool

show

)

Show or hide debug overlays.

Parameters

[in]

show

The status.

unregisterTimer()

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

Unregisters a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to unregister.

---

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

• Castor3D/Overlay/DebugOverlays.hpp