Class PerformanceMonitor
Hierarchy
- PerformanceMonitor
Index
Constructors
constructor
constructor
Parameters
Optional frameSampleSize: number
The number of samples required to saturate the sliding window
Returns PerformanceMonitor
Accessors
averageFPS
Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
Returns number
average
Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
Returns number
average
Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
Returns number
instantaneousFPS
Returns the average framerate in frames per second using the most recent frame time
Returns number
instantaneous
Returns the frame time of the most recent frame
Returns number
is
Returns true if sampling is enabled
Returns boolean
is
Returns true if enough samples have been taken to completely fill the sliding window
Returns boolean
Methods
disableSearch playground for disable
Disables contributions to the sliding window sample set Samples will not be interpolated over the disabled period
Returns void
enableSearch playground for enable
Enables contributions to the sliding window sample set
Returns void
resetSearch playground for reset
Resets performance monitor
Returns void
sample
Samples current frame
Parameters
Optional timeMs: number
A timestamp in milliseconds of the current frame to compare with other frames
Returns void
Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window