SteadyClockPolicy Class Reference

Stopwatch policy backed by std::chrono::steady_clock. More...

#include <mxvk/include/mxvk/mxvk_stopwatch.hpp>

Public Member Functions
void	echo (std::string_view name) const
	Print the recorded interval in milliseconds and nanoseconds.
void	start ()
	Record the beginning of a timed interval.
void	stop ()
	Record the end of a timed interval.
unsigned long	timePassed () const
	Return the time elapsed since the most recent start().

Detailed Description

Stopwatch policy backed by std::chrono::steady_clock.

The steady clock is monotonic, making this policy suitable for measuring elapsed wall-clock time even if the system clock is adjusted. Elapsed queries are returned in milliseconds.

Definition at line 30 of file mxvk_stopwatch.hpp.

Member Function Documentation

echo()

void SteadyClockPolicy::echo ( std::string_view name ) const

inline

Print the recorded interval in milliseconds and nanoseconds.

Parameters

name	Descriptive name shown with the timing result.

Call stop() before calling this function.

Definition at line 48 of file mxvk_stopwatch.hpp.

                                         {
        const auto elapsed = stop_time - start_time;
        std::cout << "Stopwatch [" << name << "]\n"
                  << "Timer was active for : "
                  << std::chrono::duration_cast<std::chrono::milliseconds>(elapsed).count()
                  << " Milliseconds\n"
                  << "Timer was active for : "
                  << std::chrono::duration_cast<std::chrono::nanoseconds>(elapsed).count()
                  << " Nanoseconds\n";
    }

start()

void SteadyClockPolicy::start ( )

inline

Record the beginning of a timed interval.

Definition at line 33 of file mxvk_stopwatch.hpp.

                 {
        start_time = std::chrono::steady_clock::now();
    }

stop()

void SteadyClockPolicy::stop ( )

inline

Record the end of a timed interval.

Definition at line 38 of file mxvk_stopwatch.hpp.

                {
        stop_time = std::chrono::steady_clock::now();
    }

timePassed()

unsigned long SteadyClockPolicy::timePassed ( ) const

inline

Return the time elapsed since the most recent start().

Returns

Elapsed time in milliseconds.

Definition at line 63 of file mxvk_stopwatch.hpp.

                                     {
        auto now = std::chrono::steady_clock::now();
        return std::chrono::duration_cast<std::chrono::milliseconds>(now - start_time).count();
    }

---

The documentation for this class was generated from the following file:

• mxvk/include/mxvk/mxvk_stopwatch.hpp