QualityService.h

#pragma once
 
#include "Base.h"
 
#include "Foundation/Platform/Timer.h"
 
namespace Cogs::Core
{
  enum struct QualityRequest
  {
    AtTarget,
    HasSlack,
    ThrottleDown,
    RapidBackoff,
  };
 
  enum class MetricType : unsigned int
  {
    Idle,
    Frame,
    PreRender,
    Present,
    MetricTypeCount,
  };
 
  class COGSCORE_DLL_API QualityService
  {
    friend class InspectorGuiRenderer;
    friend void renderingStatsInspector(class Context*, bool*);
  public:
 
    struct FrameTimings {
      float frameTime;    
      float cogsTime;     
      float cpuTime;      
      float presentTime;  
      float idleTime;     
    };
 
    QualityService(class Context* context);
 
    void beginFrame();
    void endFrame();
 
    void begin(MetricType metric);
    void end(MetricType metric);
 
    void updateTimes();
 
    // in [0,2]
    float getCurrentQuality() const { return currentQuality; }
 
    void requestQualityChange(QualityRequest request);
 
    FrameTimings getFrameTimings() const;
 
    float getMetric(MetricType metric);
 
    float assetSystemToleranceScale = 1.f;
 
    float potreeSystemToleranceScale = 1.f;
    float potreeSystemChunkCountScale = 1.f;
 
    // Used as control-value/status for the cache system in the OGC3DTilesSystem.
    float ogc3DTilesSystemToleranceScale = 1.0f;
    float ogc3DTilesSystemCacheControl = 1.0f;
 
  private:
    Context* context = nullptr;
    bool rapidBackoff = false;
    bool throttleDown = false;
    bool hasSlack = false;
    bool resetFrameTime = false;
    bool hasOneFrame = false;
 
    float frameTimeTarget = 0.f;
    uint32_t gpuMemTargetMB = 0;
    float avgFrameTime = 0.f;     // Exponential moving average of frame time in ms.
    float qualitySetting = 100.f;
    float currentQuality = 1.f;
 
    size_t stack_idx = 0;
 
    static constexpr size_t TIMES_COUNT = 256;
    size_t times_idx = 0;
    TimePerf time[(size_t)MetricType::MetricTypeCount];
    float times[TIMES_COUNT][(size_t)MetricType::MetricTypeCount];
 
    size_t bufferUploadSize[TIMES_COUNT];
    size_t textureUploadSize[TIMES_COUNT];
  };
}