TimerStat

Scaleform::Stat
    Scaleform::TimerStat

Declaration

class TimerStat : public Stat;

Description

TimerStat records the number of nano-second ticks used for a certain measured activity, such as rendering or tessellation. The time is most easily measured by using the TimerStat::ScopeTimer scope object around the code whose performance is to be measured. Every time that block of code is executed, the number of ticks will be incremented appropriately.

Classes

Class	Description
ScopeTimer	Scope used for timer measurements.

Data Members

Data Member	Description
Ticks	Tracks the number of nano-second ticks that passed.

Methods

Method	Description
Add	Adds the timer statistics of another TimerStat object to the current object.
AddTicks	Adds the tick value passed to the timer.
GetStatType	Returns the type of the statistics generated.
GetStat	Obtains the statistics value of the timer.
GetStatCount	Returns the maximum number of statistics in the timer.
GetTicks	Retrieves the number of nano-second ticks used for a measured activity.
Init	Initializes the timer statistics.
TimerStat	Initializes the TimerStat object.
Reset	Resets the timer statistics value to zero.
SetMax	Compares with another TimerStat object and sets the maximum of the tick value to the current TimerStat object.
SetMin	Compares with another TimerStat object and sets the minimum of the tick value to the current TimerStat object.
ScopeTimer	Initializes the scope object to measure the time.

Operators

Operator	Description
+=	Increments the tick measurements of the current TimerStat object by adding the timer statistics of another TimerStat object to the current one.

File

SF_Stats.h