FpsSampler

Index

Constructors

• constructor

Accessors

• fps
• instant

Methods

• end
• start

Constructors

constructor

• new FpsSampler(options: FpsSamplerOptions): FpsSampler

• Parameters

  • options: FpsSamplerOptions

  Returns FpsSampler

Accessors

fps

• get fps(): number

• Return the currently sampled fps over the last sample period, by default every 100ms

  ---

  Returns number

instant

• get instant(): number

• Return the instantaneous fps, this can be less useful because it will fluctuate given the current frames time

  ---

  Returns number

Methods

end

• end(): void

• End of code block to sample FPS for

  ---

  Returns void

start

• start(): void

• Start of code block to sample FPS for

  ---

  Returns void