Displays rendering stats and profiling information. More...

#include <Urho3D/SystemUI/DebugHud.h>

Inheritance diagram for Urho3D::DebugHud:

Public Member Functions
	DebugHud (Context *context)
	Construct.

	~DebugHud () override
	Destruct.

void	SetMode (DebugHudModeFlags mode)

void	CycleMode ()
	Cycle through elements.

void	Toggle (DebugHudModeFlags mode)

void	ToggleAll ()
	Toggle all elements.

DebugHudModeFlags	GetMode () const

void	SetAppStats (const ea::string &label, const Variant &stats)

void	SetAppStats (const ea::string &label, const ea::string &stats)

bool	ResetAppStats (const ea::string &label)

void	ClearAppStats ()
	Clear all application-specific stats.

void	RenderUI (DebugHudModeFlags mode)
	Render system ui.

Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.

	~Object () override
	Destruct. Clean up self from event sender & receiver structures.

virtual StringHash	GetType () const =0

virtual const ea::string &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () const =0
	Return type info.

virtual bool	IsInstanceOf (StringHash type) const =0
	Check whether current instance implements specified type.

virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

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	SubscribeToEventManual (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.

void	SubscribeToEventManual (Object sender, StringHash eventType, EventHandler handler)
	Subscribe to a specific sender's event.

template<class T >
void	SubscribeToEvent (StringHash eventType, T handler)
	Subscribe to an event that can be sent by any sender.

template<class T >
void	SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
	Unsubscribe from all events except those listed.

void	UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
	Unsubscribe from all events except those with listed senders.

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.

template<typename... Args>
void	SendEvent (StringHash eventType, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &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 ea::string &	GetCategory () const

void	SendEvent (StringHash eventType, const VariantMap &eventData)
	Send event with parameters to all subscribers.

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.

	RefCounted (const RefCounted &rhs)=delete
	Prevent copy construction.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () const
	Return pointer to the reference count structure.

bool	HasScriptObject () const
	Return true if script runtime object wrapping this native object exists.

bool	IsScriptStrongRef () const
	Return true if script reference is strong.

Private Member Functions
void	OnRenderDebugUI (StringHash, VariantMap &)
	Render debug hud on to entire viewport.

Private Attributes
ea::map< ea::string, ea::string >	appStats_ {}
	Hashmap containing application specific stats.

DebugHudModeFlags	mode_ {DEBUGHUD_SHOW_NONE}
	Current shown-element mode.

Timer	fpsTimer_ {}
	FPS timer.

unsigned	fps_ = 0
	Calculated fps.

unsigned	numChangedAnimations_ [2] {}

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Displays rendering stats and profiling information.

Member Function Documentation

◆ GetMode()

DebugHudModeFlags Urho3D::DebugHud::GetMode ( ) const

inline

Return currently shown elements.

Returns: a combination of DEBUGHUD_SHOW_* flags.

◆ ResetAppStats()

bool Urho3D::DebugHud::ResetAppStats ( const ea::string & label )

Reset application-specific stats. Return true if it was erased successfully.

Parameters

label a title of stat to be reset.

◆ SetAppStats() [1/2]

void Urho3D::DebugHud::SetAppStats	(	const ea::string &	label,
		const ea::string &	stats
	)

Set application-specific stats.

Parameters

label	a title of stat to be displayed.
stats	a string value to be displayed next to the specified label.

◆ SetAppStats() [2/2]

void Urho3D::DebugHud::SetAppStats	(	const ea::string &	label,
		const Variant &	stats
	)

Set application-specific stats.

Parameters

label	a title of stat to be displayed.
stats	a variant value to be displayed next to the specified label.

◆ SetMode()

void Urho3D::DebugHud::SetMode ( DebugHudModeFlags mode )

Set elements to show.

Parameters

mode	is a combination of DEBUGHUD_SHOW_* flags.

◆ Toggle()

void Urho3D::DebugHud::Toggle ( DebugHudModeFlags mode )

Toggle elements.

Parameters

mode	is a combination of DEBUGHUD_SHOW_* flags.

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

Urho3D/SystemUI/DebugHud.h
Urho3D/SystemUI/DebugHud.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetMode()

◆ ResetAppStats()

◆ SetAppStats() [1/2]

◆ SetAppStats() [2/2]

◆ SetMode()

◆ Toggle()