clock.hxx

Go to the documentation of this file.

 
#pragma once
#include <ice/clock_types.hxx>
 
namespace ice
{

    struct Clock
    {
        ice::Timestamp _ts_previous;
        ice::Timestamp _ts_latest;
    };

    struct SystemClock : ice::Clock { };

    struct CustomClock : ice::Clock
    {
        ice::Clock const* _clock_base;
        ice::f32 modifier;
    };
 
    struct Timer
    {
        ice::Clock const* _clock_base;
        ice::Timestamp _timer_step;
        ice::Timestamp _ts_latest;
    };
 
    struct Timeline
    {
        ice::Clock const* _clock_base;
        ice::Timestamp _ts_initial;
    };
 
    struct Stopwatch
    {
        ice::Clock const* clock;
 
        ice::Timestamp _ts_initial;
        ice::Timestamp _ts_final;
    };
 
    namespace clock
    {
 
        auto now() noexcept -> ice::Timestamp;
 
        auto clock_frequency() noexcept -> ice::ClockFrequency;
 
        auto create_clock() noexcept -> ice::SystemClock;
 
        auto create_clock(
            ice::Clock const& clock,
            ice::f32 modifier
        ) noexcept -> ice::CustomClock;
 
        void update(ice::SystemClock& clock) noexcept;
 
        void update(ice::CustomClock& clock) noexcept;
 
        void update_max_delta(
            ice::CustomClock& clock,
            ice::Tns max_delta
        ) noexcept;
 
        auto elapsed(ice::Clock const& clock) noexcept -> ice::Tns;
 
        auto elapsed(ice::Timestamp start, ice::Timestamp end) noexcept -> ice::Tns;
 
    } // namespace clock
 
    namespace timer
    {
 
        auto create_timer(
            ice::Clock const& clock,
            ice::Tns timer_step
        ) noexcept -> ice::Timer;
 
        auto create_timer(
            ice::Clock const& clock,
            ice::Tns timer_step,
            ice::Timestamp initial_timestamp
        ) noexcept -> ice::Timer;
 
        bool update(ice::Timer& timer) noexcept;
 
        bool update_by_step(ice::Timer& timer) noexcept;
 
        auto elapsed(ice::Timer const& timer) noexcept -> ice::Tns;
 
        auto elapsed_us(ice::Timer const& timer) noexcept -> ice::Tus;
 
        auto alpha(ice::Timer const& timer) noexcept -> ice::f32;
 
    } // namespace timer
 
    namespace timeline
    {
 
        auto create_timeline(ice::Clock const& clock) noexcept -> ice::Timeline;
 
        void reset(ice::Timeline& timeline) noexcept;
 
        auto elapsed(ice::Timeline const& timeline) noexcept -> ice::Tns;
 
        auto elapsed_us(ice::Timeline const& timeline) noexcept -> ice::Tus;
 
    } // namespace timeline
 
    namespace stopwatch
    {
 
        // Always uses system clock
        auto create_stopwatch() noexcept -> ice::Stopwatch;
        auto create_stopwatch(ice::Clock const& clock) noexcept -> ice::Stopwatch;
 
        auto elapsed(ice::Stopwatch const& stopwatch) noexcept -> ice::Tns;
        auto elapsed_us(ice::Stopwatch const& stopwatch) noexcept -> ice::Tus;
 
        void start(ice::Stopwatch& stopwatch) noexcept;
 
        void stop(ice::Stopwatch& stopwatch) noexcept;
 
    } // namespace stopwatch
 
} // namespace ice