Tiny module for measuring FPS
JavaScript
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
LICENSE.md first commit May 4, 2013
README.md Fix small typo in readme Aug 21, 2013
index.js Allow for using Date.now too... May 4, 2013
package.json 0.0.2 May 4, 2013
test.js first commit May 4, 2013

README.md

fps

A little module for measuring FPS (frames per second) rates in the browser and Node. Note that this module only covers measuring and not display, so if you're looking for something more "plug and play" you should try stats.js or FPSMeter.

Installation

npm install fps

Usage

var fps = require('fps')
var ticker = fps({
    every: 10   // update every 10 frames
})

setInterval(function() {
  ticker.tick()
}, 1000 / 60)

var element = document.getElementById('fps')
ticker.on('data', function(framerate) {
  element.innerHTML = String(framerate)
})

ticker = require('fps')([options])

Returns a new FPS monitor. Takes the following options:

  • every: how many frames to tick before emitting. Defaults to 1.
  • decay: the rate of change between old and new results. 1 is instantaneous, 0 is never.

ticker.tick()

Call this method at the beginning of each frame to update the measurements and emit new results.

ticker.on('data', callback)

Called when periodically for every options.every ticks.

ticker.rate

The current framerate can be accessed directly here.