Urho3D::DebugHud Class Reference

Displays rendering stats and profiling information. More...

#include <Urho3D/Engine/DebugHud.h>

Inheritance diagram for Urho3D::DebugHud:

Collaboration diagram for Urho3D::DebugHud:

Public Member Functions
	DebugHud (Context *context)
	Construct.
	~DebugHud ()
	Destruct.
void	Update ()
	Update. Called by HandlePostUpdate().
void	SetDefaultStyle (XMLFile *style)
	Set UI elements' style from an XML file.
void	SetMode (unsigned mode)
	Set elements to show.
void	SetProfilerMaxDepth (unsigned depth)
	Set maximum profiler block depth, default unlimited.
void	SetProfilerInterval (float interval)
	Set profiler accumulation interval in seconds.
void	SetUseRendererStats (bool enable)
	Set whether to show 3D geometry primitive/batch count only. Default false.
void	Toggle (unsigned mode)
	Toggle elements.
void	ToggleAll ()
	Toggle all elements.
XMLFile *	GetDefaultStyle () const
	Return the UI style file.
Text *	GetStatsText () const
	Return rendering stats text.
Text *	GetModeText () const
	Return rendering mode text.
Text *	GetProfilerText () const
	Return profiler text.
Text *	GetMemoryText () const
	Return memory text.
unsigned	GetMode () const
	Return currently shown elements.
unsigned	GetProfilerMaxDepth () const
	Return maximum profiler block depth.
float	GetProfilerInterval () const
	Return profiler accumulation interval in seconds.
bool	GetUseRendererStats () const
	Return whether showing 3D geometry primitive/batch count only.
void	SetAppStats (const String &label, const Variant &stats)
	Set application-specific stats.
void	SetAppStats (const String &label, const String &stats)
	Set application-specific stats.
bool	ResetAppStats (const String &label)
	Reset application-specific stats. Return true if it was erased successfully.
void	ClearAppStats ()
	Clear all application-specific stats.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual StringHash	GetType () const =0
	Return type hash.
virtual const String &	GetTypeName () const =0
	Return type name.
virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
bool	IsInstanceOf (StringHash type) const
	Check current instance is type of specified type.
bool	IsInstanceOf (const TypeInfo *typeInfo) const
	Check current instance is type of specified type.
template<typename T >
bool	IsInstanceOf () const
	Check current instance is type of specified class.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers.
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
const Variant &	GetGlobalVar (StringHash key) const
	Return global variable based on key.
const VariantMap &	GetGlobalVars () const
	Return all global variables.
void	SetGlobalVar (StringHash key, const Variant &value)
	Set global variable with the respective key and value.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	URHO3D_OBJECT (DebugHud, Object)
void	HandlePostUpdate (StringHash eventType, VariantMap &eventData)
	Handle logic post-update event. The HUD texts are updated here.

Private Attributes
SharedPtr< Text >	statsText_
	Rendering stats text.
SharedPtr< Text >	modeText_
	Rendering mode text.
SharedPtr< Text >	profilerText_
	Profiling information text.
SharedPtr< Text >	eventProfilerText_
	Event profiling information text.
SharedPtr< Text >	memoryText_
	Memory stats text.
HashMap< String, String >	appStats_
	Hashmap containing application specific stats.
Timer	profilerTimer_
	Profiler timer.
unsigned	profilerMaxDepth_
	Profiler max block depth.
unsigned	profilerInterval_
	Profiler accumulation interval.
bool	useRendererStats_
	Show 3D geometry primitive/batch count flag.
unsigned	mode_
	Current shown-element mode.

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Displays rendering stats and profiling information.

---

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

• Source/Urho3D/Engine/DebugHud.h
• Source/Urho3D/Engine/DebugHud.cpp