urho3d/Extras/LuaScript/pkgs/Engine/DebugHud.pkg

$#include "DebugHud.h"

static const unsigned DEBUGHUD_SHOW_NONE;
static const unsigned DEBUGHUD_SHOW_STATS;
static const unsigned DEBUGHUD_SHOW_MODE;
static const unsigned DEBUGHUD_SHOW_PROFILER;
static const unsigned DEBUGHUD_SHOW_ALL;

/// Displays rendering stats and profiling information.
class DebugHud : public Object
{
public:
    /// Update. Called by HandleUpdate().
    void Update();
    
    /// Set UI elements' style from an XML file.
    void SetDefaultStyle(XMLFile* style);
    
    /// Set elements to show.
    void SetMode(unsigned mode);
    
    /// Set maximum profiler block depth, default unlimited.
    void SetProfilerMaxDepth(unsigned depth);
    
    /// Set profiler accumulation interval in seconds.
    void SetProfilerInterval(float interval);
    
    /// Set whether to show 3D geometry primitive/batch count only. Default false.
    void SetUseRendererStats(bool enable);
    
    /// Toggle elements.
    void Toggle(unsigned mode);
    
    /// Toggle all elements.
    void ToggleAll();

    /// Return the UI style file.
    XMLFile* GetDefaultStyle() const;
    
    /// Return rendering stats text.
    Text* GetStatsText() const;
    
    /// Return rendering mode text.
    Text* GetModeText() const;
    
    /// Return profiler text.
    Text* GetProfilerText() const;
    
    /// Return currently shown elements.
    unsigned GetMode() const;
    
    /// Return maximum profiler block depth.
    unsigned GetProfilerMaxDepth() const;
    
    /// Return profiler accumulation interval in seconds
    float GetProfilerInterval() const;

    /// Return whether showing 3D geometry primitive/batch count only.
    bool GetUseRendererStats() const;
    
    /// Set application-specific stats.
    void SetAppStats(const String& label, const Variant& stats);
    
    /// Set application-specific stats.
    void SetAppStats(const String& label, const String& stats);
    
    /// Reset application-specific stats. Return true if it was erased successfully.
    bool ResetAppStats(const String& label);
    
    /// Clear all application-specific stats.
    void ClearAppStats();
    
    // Properties:
    tolua_property__get_set XMLFile* defaultStyle;
    tolua_property__get_set unsigned mode;
    tolua_property__get_set unsigned profilerMaxDepth;
    tolua_property__get_set float profilerInterval;
    tolua_property__get_set bool useRendererStats;
    tolua_readonly tolua_property__get_set Text* statsText;
    tolua_readonly tolua_property__get_set Text* modeText;
    tolua_readonly tolua_property__get_set Text* profilerText;
};