flutter::Stopwatch Class Reference

#include <stopwatch.h>

Inheritance diagram for flutter::Stopwatch:

Classes
class	RefreshRateUpdater
	The refresh rate interface for Stopwatch. More...

Public Member Functions
	Stopwatch (const RefreshRateUpdater &updater)
	~Stopwatch ()
const fml::TimeDelta &	GetLap (size_t index) const
size_t	GetLapsCount () const
	Return a reference to all the laps. More...
size_t	GetCurrentSample () const
const fml::TimeDelta &	LastLap () const
fml::TimeDelta	MaxDelta () const
fml::TimeDelta	AverageDelta () const
void	Start ()
void	Stop ()
void	SetLapTime (const fml::TimeDelta &delta)
fml::Milliseconds	GetFrameBudget () const
	All places which want to get frame_budget should call this function. More...

Detailed Description

Definition at line 17 of file stopwatch.h.

Constructor & Destructor Documentation

Stopwatch()

flutter::Stopwatch::Stopwatch ( const RefreshRateUpdater &  updater )

explicit

The constructor with a updater parameter, it will update frame_budget everytime when GetFrameBudget() is called.

Definition at line 11 of file stopwatch.cc.

    : refresh_rate_updater_(updater), start_(fml::TimePoint::Now()) {
  const fml::TimeDelta delta = fml::TimeDelta::Zero();
  laps_.resize(kMaxSamples, delta);
}

~Stopwatch()

flutter::Stopwatch::~Stopwatch ( )

default

Member Function Documentation

AverageDelta()

fml::TimeDelta flutter::Stopwatch::AverageDelta

(

)

const

Definition at line 80 of file stopwatch.cc.

                                           {
  fml::TimeDelta sum;  // default to 0
  for (size_t i = 0; i < kMaxSamples; i++) {
    sum = sum + laps_[i];
  }
  return sum / kMaxSamples;
}

GetCurrentSample()

size_t flutter::Stopwatch::GetCurrentSample

(

)

const

Definition at line 53 of file stopwatch.cc.

                                         {
  return current_sample_;
}

GetFrameBudget()

fml::Milliseconds flutter::Stopwatch::GetFrameBudget

(

)

const

All places which want to get frame_budget should call this function.

Definition at line 88 of file stopwatch.cc.

                                                {
  return refresh_rate_updater_.GetFrameBudget();
}

GetLap()

const fml::TimeDelta & flutter::Stopwatch::GetLap

(

size_t

index

)

const

Definition at line 45 of file stopwatch.cc.

                                                        {
  return laps_[index];
}

GetLapsCount()

size_t flutter::Stopwatch::GetLapsCount

(

)

const

Return a reference to all the laps.

Definition at line 49 of file stopwatch.cc.

                                     {
  return laps_.size();
}

LastLap()

const fml::TimeDelta & flutter::Stopwatch::LastLap

(

)

const

Definition at line 41 of file stopwatch.cc.

                                             {
  return laps_[(current_sample_ - 1) % kMaxSamples];
}

MaxDelta()

fml::TimeDelta flutter::Stopwatch::MaxDelta

(

)

const

Definition at line 70 of file stopwatch.cc.

                                       {
  fml::TimeDelta max_delta;
  for (size_t i = 0; i < kMaxSamples; i++) {
    if (laps_[i] > max_delta) {
      max_delta = laps_[i];
    }
  }
  return max_delta;
}

SetLapTime()

void flutter::Stopwatch::SetLapTime

(

const fml::TimeDelta &

delta

)

Definition at line 36 of file stopwatch.cc.

                                                    {
  current_sample_ = (current_sample_ + 1) % kMaxSamples;
  laps_[current_sample_] = delta;
}

Start()

void flutter::Stopwatch::Start

(

)

Definition at line 27 of file stopwatch.cc.

                      {
  start_ = fml::TimePoint::Now();
  current_sample_ = (current_sample_ + 1) % kMaxSamples;
}

Stop()

void flutter::Stopwatch::Stop

(

)

Definition at line 32 of file stopwatch.cc.

                     {
  laps_[current_sample_] = fml::TimePoint::Now() - start_;
}

---

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

• flow/stopwatch.h
• flow/stopwatch.cc