Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "fps-meter"

Allows you to capture the frames-per-second metrics of your application.

Index

Functions

addCallback

  • addCallback(callback: function): number
  • Adds a callback function to be called each time FPS data is due to be reported. Returns an unique id which can be used to remove this callback later.

    Parameters

    • callback: function
        • (fps: number, minFps?: number): void
        • Parameters

          • fps: number
          • Optional minFps: number

          Returns void

    Returns number

removeCallback

  • removeCallback(id: number): any

running

  • running(): boolean
  • Returns a valid indicating whether the frames-per-second meter is currently running.

    Returns boolean

start

  • start(): void

stop

  • stop(): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method