DiagnosticsHud.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <deque>
#include <string>
#include <vector>
 
#include "HMI/Graphics/ComposedScene.h"

 
namespace hmi {
 
class Localization;

inline constexpr float DIAGNOSTICS_FPS_WINDOW_SECONDS = 0.5f;

class FrameRateAverage {
public:
    void addSample(float deltaSeconds) noexcept;

    [[nodiscard]] float framesPerSecond() const noexcept;

    void reset() noexcept;
 
private:
    std::deque<float> _recentDeltas;
    float _accumulatedSeconds = 0.0f;
};

struct DiagnosticsMeasurements {
    float framesPerSecond = 0.0f;
    SceneStatistics sceneStatistics{};
    int simulationSteps = 0;
};

[[nodiscard]] std::vector<std::string> composeDiagnosticsHudLines(
    const DiagnosticsMeasurements& measurements, const Localization& localization);
 
}  // namespace hmi