Profiler.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
 
#include "common/Capability.h"
#include "common/GpuTimer.h"
#include "common/Module.h"
#include "common/Profile.h"
#include "common/RenderTrace.h"
#include "common/Result.h"
 
#include <squirrel.h>
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace ssq {
class Object;
}
 
namespace eve::profiler {
 
struct ProfilerZoneSnapshot {
    std::string module;
    std::string name;
    std::string thread;
    double      selfMs  = 0.0;
    double      totalMs = 0.0;
    int         count   = 0;
    int         depth   = 0;
};
 
struct ProfilerFrameSnapshot {
    uint64_t                          sequence   = 0;
    double                            cpuFrameMs = 0.0;
    double                            gpuFrameMs = 0.0;
    bool                              gpuTimingAvailable = false;
    std::vector<ProfilerZoneSnapshot> zones;
};
 
class EVENGINE_API_FOUNDATION Profiler : public Module, public eve::debug::IRenderTracer {
public:
    Module_REG(Profiler);
    Profiler();
    ~Profiler() override;
 
    void setEnabled(bool on);
    bool enabled() const;
    void reset();
 
    void beginFrame();
    void endFrame();
 
    void begin(const char* name);
    void end();
 
    bool hasFrame() const;
    float frameMs() const;
    float gpuFrameMs() const;
    [[nodiscard]] eve::Result<ProfilerFrameSnapshot> captureFrame() const;
    std::string textReport() const;
    ssq::Object capture();
 
    // IRenderTracer: route render passes into the core as "graphics" zones and
    // drive automatic per-frame aggregation from the render frame boundary.
    void frameBegin() override;
    void frameEnd() override;
    void passBegin(const char* name) override;
    void passEnd(const char* name) override;
    void draw(const char* api, const char* detail) override {}
 
private:
    void ensureGpuTimer() const;
 
    int64_t frameBeginNs_ = 0;
    float   frameMs_      = 0.f;
    uint64_t captureSequence_ = 0;
    HSQUIRRELVM vm_       = nullptr;
    mutable eve::cap::ProviderRef<eve::service::IGpuTimer> gpuTimer_;
};
 
void registerProfilerCapabilities();
 
}  // namespace eve::profiler