Application.hpp

Go to the documentation of this file.

#ifndef DONUT_APPLICATION_APPLICATION_HPP
#define DONUT_APPLICATION_APPLICATION_HPP
 
#include <donut/application/FrameInfo.hpp>
#include <donut/application/TickInfo.hpp>
 
#include <chrono> // std::chrono::...
 
namespace donut::application {
 
struct ApplicationOptions {
    float tickRate = 60.0f;
 
    float minFrameRate = 1.0f;
 
    float maxFrameRate = 480.0f;
 
    bool frameRateLimiterSleepEnabled = true;
 
    std::chrono::steady_clock::duration frameRateLimiterSleepBias = std::chrono::microseconds{100};
};
 
class Application {
public:
    explicit Application(const ApplicationOptions& options = {});
 
    virtual ~Application() = default;
 
    void run();
 
    virtual void quit();
 
    [[nodiscard]] bool isRunning() const noexcept {
        return running;
    }
 
    [[nodiscard]] unsigned getLastSecondFrameCount() const noexcept {
        return lastSecondFrameCount;
    }
 
    void setFrameRateParameters(float tickRate, float minFrameRate, float maxFrameRate);
 
    void setFrameRateLimiterSleepEnabled(bool frameRateLimiterSleepEnabled);
 
    void setFrameRateLimiterSleepBias(std::chrono::steady_clock::duration frameRateLimiterSleepBias);
 
    [[nodiscard]] TickInfo getLatestTickInfo() const noexcept {
        return tickInfo;
    }
 
    [[nodiscard]] FrameInfo getLatestFrameInfo() const noexcept {
        return frameInfo;
    }
 
protected:
    virtual void update(FrameInfo frameInfo) {
        (void)frameInfo;
    }
 
    virtual void tick(TickInfo tickInfo) {
        (void)tickInfo;
    }
 
    virtual void display(TickInfo tickInfo, FrameInfo frameInfo) {
        (void)tickInfo;
        (void)frameInfo;
    }
 
private:
    void runFrame();
 
    using Clock = std::chrono::steady_clock;
 
    Clock::duration tickInterval{};
    Clock::duration minFrameInterval{};
    Clock::rep maxTicksPerFrame{};
    Clock::time_point startTime{};
    Clock::time_point latestFrameTime{};
    Clock::time_point latestTickProcessingEndTime{};
    Clock::time_point latestFrameCountTime{};
    unsigned lastSecondFrameCount = 0u;
    unsigned frameCounter = 0u;
    TickInfo tickInfo{};
    FrameInfo frameInfo{};
    Clock::duration frameRateLimiterSleepBias{};
    bool frameRateLimiterSleepEnabled = false;
    bool running = false;
};
 
} // namespace donut::application
 
#endif