Displays rendering stats and profiling information. More...

#include <Urho3D/Engine/DebugHud.h>

Inheritance diagram for Urho3D::DebugHud:
[legend]
Collaboration diagram for Urho3D::DebugHud:
[legend]

Public Member Functions

 DebugHud (Context *context)
 Construct.
 
virtual ~DebugHud () override
 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.
 
XMLFileGetDefaultStyle () const
 Return the UI style file.
 
TextGetStatsText () const
 Return rendering stats text.
 
TextGetModeText () const
 Return rendering mode text.
 
TextGetProfilerText () const
 Return profiler text.
 
TextGetMemoryText () 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 () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () 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.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived 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 SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- 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.
 
RefCountRefCountPtr ()
 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< TextstatsText_
 Rendering stats text.
 
SharedPtr< TextmodeText_
 Rendering mode text.
 
SharedPtr< TextprofilerText_
 Profiling information text.
 
SharedPtr< TexteventProfilerText_
 Event profiling information text.
 
SharedPtr< TextmemoryText_
 Memory stats text.
 
HashMap< String, StringappStats_
 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 TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 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