GteOnIdleTimer.h

Go to the documentation of this file.

// David Eberly, Geometric Tools, Redmond WA 98052
// Copyright (c) 1998-2017
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
// File Version: 3.0.0 (2016/06/19)

#pragma once

#include <GTEngineDEF.h>
#include <chrono>
#include <cstdint>
#include <string>

namespace gte
{

class GTE_IMPEXP OnIdleTimer
{
public:
    // The 'frequency' is how many calls of OnIdle() occur before the
    // high-frequency clock is called.
    OnIdleTimer(int64_t frequency = 30);

    // Restart the timer from zero.  This is useful to call after the
    // application has "warmed up."
    void Reset();

    // Call this function at the beginning of OnIdle().
    void Measure();

    // Call this function at the end of OnIdle();
    inline void UpdateFrameCount();

    // Report the rates.
    double GetFramesPerSecond() const;
    double GetSecondsPerFrame() const;
    int64_t GetMillisecondsPerFrame() const;

    // For convenience in displaying a formatted frames-per-second string.
    std::string GetFPS() const;

private:
    // The accumulated time is measured in milliseconds.
    int64_t mFrequency, mCallCount;
    int64_t mFrameCount, mAccumulatedFrameCount, mAccumulatedTime;
    std::chrono::high_resolution_clock::time_point mTime0, mTime1;
};


inline void OnIdleTimer::UpdateFrameCount()
{
    ++mFrameCount;
}


}