Timing.h

Go to the documentation of this file.

 
#pragma once
 
#include <array>
 
#include <tdme/tdme.h>
#include <tdme/engine/fwd-tdme.h>
 
using std::array;
 
/**
 * Timing class
 * @author Andreas Drewke
 */
class tdme::engine::Timing final
{
    friend class Engine;
 
public:
    static constexpr int64_t UNDEFINED { -1LL };
 
private:
    int64_t frame;
    int64_t startTime;
    int64_t lastFrameAtTime;
    int64_t currentFrameAtTime;
    float fps;
    float avarageFPS;
    array<float, 60 * 3> avarageFPSSequence;
    int avarageFPSIndex { 0 };
 
    /**
     * Updates timing
     */
    void updateTiming();
 
    // forbid class copy
    FORBID_CLASS_COPY(Timing)
 
public:
    /**
     * Public constructor
     */
    Timing();
 
    /**
     * @return frames that have been rendered
     */
    inline int64_t getFrame() {
        return frame;
    }
 
    /**
     * @return start time
     */
    inline int64_t getStartTime() {
        return startTime;
    }
 
    /**
     * @return total time the engine is running
     */
    inline int64_t getTotalTime() {
        return currentFrameAtTime - startTime;
    }
 
    /**
     * @return time last frame has been rendered in ms
     */
    inline int64_t getLastFrameAtTime() {
        return lastFrameAtTime;
    }
 
    /**
     * @return time current frame has been rendered in ms
     */
    inline int64_t getCurrentFrameAtTime() {
        return currentFrameAtTime;
    }
 
    /**
     * Gets the time passed between last and current frame
     * @return delta time
     */
    inline int64_t getDeltaTime() {
        if (currentFrameAtTime == UNDEFINED || lastFrameAtTime == UNDEFINED) {
            return 0LL;
        }
        return currentFrameAtTime - lastFrameAtTime;
    }
 
    /**
     * Gets the time passed between last and current frame in seconds
     * @return delta time in seconds
     */
    inline float getDeltaTimeSeconds() {
        return static_cast<float>(getDeltaTime()) / 1000.0f;
    }
 
    /**
     * @return avarage fps
     */
    inline float getFPS() {
        return fps;
    }
 
    /**
     * @return avarage fps
     */
    inline float getAvarageFPS() {
        return avarageFPS;
    }
 
};