OpenSiv3D  v0.6.5
C++20 framework for creative coding
s3d::VariableSpeedStopwatch Class Reference

#include <VariableSpeedStopwatch.hpp>

Public Member Functions

SIV3D_NODISCARD_CXX20 VariableSpeedStopwatch (StartImmediately startImmediately=StartImmediately::No, ISteadyClock *pSteadyClock=nullptr)
 
SIV3D_NODISCARD_CXX20 VariableSpeedStopwatch (double speed, StartImmediately startImmediately=StartImmediately::No, ISteadyClock *pSteadyClock=nullptr)
 
SIV3D_NODISCARD_CXX20 VariableSpeedStopwatch (const Duration &startTime, double speed=1.0, StartImmediately startImmediately=StartImmediately::No, ISteadyClock *pSteadyClock=nullptr)
 
bool isStarted () const noexcept
 
bool isPaused () const noexcept
 
bool isRunning () const noexcept
 
void start ()
 
void pause ()
 
void resume ()
 
void reset () noexcept
 
void restart ()
 
void set (const Duration &time)
 
void setSpeed (double speed)
 
double getSpeed () const noexcept
 
int32 d () const
 
int64 d64 () const
 
double dF () const
 
int32 h () const
 
int64 h64 () const
 
double hF () const
 
int32 min () const
 
int64 min64 () const
 
double minF () const
 
int32 s () const
 
int64 s64 () const
 
double sF () const
 
int32 ms () const
 
int64 ms64 () const
 
double msF () const
 
int64 us () const
 
int64 us64 () const
 
double usF () const
 
Duration elapsed () const
 
String format (StringView format=U"H:mm:ss.xx"_sv) const
 

Friends

bool operator< (const VariableSpeedStopwatch &s, const MicrosecondsF &time)
 
bool operator<= (const VariableSpeedStopwatch &s, const MicrosecondsF &time)
 
bool operator> (const VariableSpeedStopwatch &s, const MicrosecondsF &time)
 
bool operator>= (const VariableSpeedStopwatch &s, const MicrosecondsF &time)
 
bool operator< (const MicrosecondsF &time, const VariableSpeedStopwatch &s)
 
bool operator<= (const MicrosecondsF &time, const VariableSpeedStopwatch &s)
 
bool operator> (const MicrosecondsF &time, const VariableSpeedStopwatch &s)
 
bool operator>= (const MicrosecondsF &time, const VariableSpeedStopwatch &s)
 
template<class CharType >
std::basic_ostream< CharType > & operator<< (std::basic_ostream< CharType > &output, const VariableSpeedStopwatch &value)
 
void Formatter (FormatData &formatData, const VariableSpeedStopwatch &value)
 

Constructor & Destructor Documentation

◆ VariableSpeedStopwatch() [1/3]

SIV3D_NODISCARD_CXX20 s3d::VariableSpeedStopwatch::VariableSpeedStopwatch ( StartImmediately  startImmediately = StartImmediately::No,
ISteadyClock pSteadyClock = nullptr 
)
explicit

◆ VariableSpeedStopwatch() [2/3]

SIV3D_NODISCARD_CXX20 s3d::VariableSpeedStopwatch::VariableSpeedStopwatch ( double  speed,
StartImmediately  startImmediately = StartImmediately::No,
ISteadyClock pSteadyClock = nullptr 
)
explicit

◆ VariableSpeedStopwatch() [3/3]

SIV3D_NODISCARD_CXX20 s3d::VariableSpeedStopwatch::VariableSpeedStopwatch ( const Duration startTime,
double  speed = 1.0,
StartImmediately  startImmediately = StartImmediately::No,
ISteadyClock pSteadyClock = nullptr 
)
explicit

Member Function Documentation

◆ d()

int32 s3d::VariableSpeedStopwatch::d ( ) const

◆ d64()

int64 s3d::VariableSpeedStopwatch::d64 ( ) const

◆ dF()

double s3d::VariableSpeedStopwatch::dF ( ) const

◆ elapsed()

Duration s3d::VariableSpeedStopwatch::elapsed ( ) const

◆ format()

String s3d::VariableSpeedStopwatch::format ( StringView  format = U"H:mm:ss.xx"_sv) const

◆ getSpeed()

double s3d::VariableSpeedStopwatch::getSpeed ( ) const
noexcept

◆ h()

int32 s3d::VariableSpeedStopwatch::h ( ) const

◆ h64()

int64 s3d::VariableSpeedStopwatch::h64 ( ) const

◆ hF()

double s3d::VariableSpeedStopwatch::hF ( ) const

◆ isPaused()

bool s3d::VariableSpeedStopwatch::isPaused ( ) const
noexcept

◆ isRunning()

bool s3d::VariableSpeedStopwatch::isRunning ( ) const
noexcept

◆ isStarted()

bool s3d::VariableSpeedStopwatch::isStarted ( ) const
noexcept

◆ min()

int32 s3d::VariableSpeedStopwatch::min ( ) const

◆ min64()

int64 s3d::VariableSpeedStopwatch::min64 ( ) const

◆ minF()

double s3d::VariableSpeedStopwatch::minF ( ) const

◆ ms()

int32 s3d::VariableSpeedStopwatch::ms ( ) const

◆ ms64()

int64 s3d::VariableSpeedStopwatch::ms64 ( ) const

◆ msF()

double s3d::VariableSpeedStopwatch::msF ( ) const

◆ pause()

void s3d::VariableSpeedStopwatch::pause ( )

◆ reset()

void s3d::VariableSpeedStopwatch::reset ( )
noexcept

◆ restart()

void s3d::VariableSpeedStopwatch::restart ( )

◆ resume()

void s3d::VariableSpeedStopwatch::resume ( )

◆ s()

int32 s3d::VariableSpeedStopwatch::s ( ) const

◆ s64()

int64 s3d::VariableSpeedStopwatch::s64 ( ) const

◆ set()

void s3d::VariableSpeedStopwatch::set ( const Duration time)

◆ setSpeed()

void s3d::VariableSpeedStopwatch::setSpeed ( double  speed)

◆ sF()

double s3d::VariableSpeedStopwatch::sF ( ) const

◆ start()

void s3d::VariableSpeedStopwatch::start ( )

◆ us()

int64 s3d::VariableSpeedStopwatch::us ( ) const

◆ us64()

int64 s3d::VariableSpeedStopwatch::us64 ( ) const

◆ usF()

double s3d::VariableSpeedStopwatch::usF ( ) const

Friends And Related Function Documentation

◆ Formatter

void Formatter ( FormatData formatData,
const VariableSpeedStopwatch value 
)
friend
Parameters
formatData
value

◆ operator< [1/2]

bool operator< ( const MicrosecondsF time,
const VariableSpeedStopwatch s 
)
friend

◆ operator< [2/2]

bool operator< ( const VariableSpeedStopwatch s,
const MicrosecondsF time 
)
friend

◆ operator<<

template<class CharType >
std::basic_ostream<CharType>& operator<< ( std::basic_ostream< CharType > &  output,
const VariableSpeedStopwatch value 
)
friend
Template Parameters
CharType
Parameters
output
value
Returns

◆ operator<= [1/2]

bool operator<= ( const MicrosecondsF time,
const VariableSpeedStopwatch s 
)
friend

◆ operator<= [2/2]

bool operator<= ( const VariableSpeedStopwatch s,
const MicrosecondsF time 
)
friend

◆ operator> [1/2]

bool operator> ( const MicrosecondsF time,
const VariableSpeedStopwatch s 
)
friend

◆ operator> [2/2]

bool operator> ( const VariableSpeedStopwatch s,
const MicrosecondsF time 
)
friend

◆ operator>= [1/2]

bool operator>= ( const MicrosecondsF time,
const VariableSpeedStopwatch s 
)
friend

◆ operator>= [2/2]

bool operator>= ( const VariableSpeedStopwatch s,
const MicrosecondsF time 
)
friend

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