fpsdisplay v0.1.3
fpsdisplay
A simple frames per second display.
##Install
To include fpsdisplay as a component in your project, use the node module.
npm install fpsdisplay --saveYou can also use the standalone version and reference the js file from your document.
<html>
<head>
<script src="scripts/fpsdisplay.min.js" type="text/javascript" charset="utf-8"></script>
</head>
...##Usage
The module exports a FPSDisplay class. In a nodejs project, you access it via:
var FPSDisplay = require('../src/fpsdisplay');In the browser, the module exposes an FPSDisplay class. Call init() to render the display. Call FPSDisplay.update from an animation loop to track the frames per second.
<html>
<head>
<script src="scripts/fpsdisplay.min.js" type="text/javascript" charset="utf-8"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
window.requestAnimationFrame = window.requestAnimationFrame || window.mozRequestAnimationFrame ||
window.webkitRequestAnimationFrame || window.msRequestAnimationFrame;
FPSDisplay.init();
function loop() {
FPSDisplay.update();
window.requestAnimationFrame(loop);
}
loop();Use the show()/hide() methods to toggle the display.
...
document.addEventListener('keyup', function(e) {
switch (e.keyCode) {
case 83: // 's'
if (FPSDisplay.active) {
FPSDisplay.hide();
} else {
FPSDisplay.show();
}
break;
}
});
...Please review the docs for more details.
##Building this project
This project uses Grunt. To build the project first install the node modules.
npm installNext, run grunt.
gruntTo run the tests, run 'npm test'.
npm testTo check test coverage run 'grunt coverage'.
grunt coverageA pre-commit hook is defined in /pre-commit that runs jshint. To use the hook, run the following:
ln -s ../../pre-commit .git/hooks/pre-commitA post-commit hook is defined in /post-commit that runs the Plato complexity analysis tools. To use the hook, run the following:
ln -s ../../post-commit .git/hooks/post-commitView the code complexity report.