FpsMeter

class FpsMeter

import { FpsMeter } from '@driftengine/core';

Constructor

constructor(options?: FpsMeterOptions)

Parameter	Type	Description
`options?`	`FpsMeterOptions`

Name	Type	Description
`fps`get	`number`	The rate this meter last computed, for a caller that wants the number as well as the panel. More Reported from outside, by a consumer that had to keep its own average beside this one to say "the preview is below rate, the export is unaffected". A class that owns an element and refuses to say what it wrote in it makes every caller measure the same thing twice. These are what was last displayed, so they move at `updateIntervalMs` rather than per frame, which is the point: a figure that changes sixty times a second is not one a person reads, and a caller comparing against a budget wants the same smoothed number the panel shows. Zero until the first update, which is a real state and not a rate.
`meanMs`get	`number`	Mean frame time in milliseconds over the window, as last displayed. See `fps`.
`worstMs`get	`number`	The slowest frame in the window in milliseconds, as last displayed. See `fps`.

sample(frameDt: number, nowMs: number): void

Call once per rendered frame with duration in seconds.

Parameter	Type	Description
`frameDt`	`number`
`nowMs`	`number`

dispose(): void