FpsAnalyzr

Recording and analysis for framerate measurements.

Usage

Constructor

import { FPSAnalyzr } from "fpsanalyzr";

const fpsAnalyzer = new FpsAnalyzr();

setInterval(() => fpsAnalyzer.tick(performance.now()), 1000 / 60);

maximumKept

By default, the past 250 tick times are kept. You can override this by passing in a maximumKept number.

new FpsAnalyzr({
    maximumKept: 50,
});

---

tick

Records that a frame tick has happened.

Receives: number representing the current timestamp, in milliseconds.

fpsAnalyzer.tick(performance.now());

getAverage

Returns: number for the computed average framerate among stored measurements.

setInterval(() => fpsAnalyzer.tick(performance.now()), 1000 / 60);

setInterval(
    () => {
        const average = fpsAnalyzer.getAverage();
        console.log(`Average FPS this second: ${average}.`);
    },
    1000);

getExtremes

Returns: Object with .highest and .lowest computed framerate among stored measurements.

setInterval(() => fpsAnalyzer.tick(performance.now()), 1000 / 60);

setInterval(
    () => {
        const { highest, lowest } = fpsAnalyzer.getExtremes();
        console.log(`FPS this second: from ${lowest} to ${highest}.`);
    },
    1000);

getMedian

Returns: number for the computed median framerate among stored measurements.

setInterval(() => fpsAnalyzer.tick(performance.now()), 1000 / 60);

setInterval(
    () => {
        const median = fpsAnalyzer.getMedian();
        console.log(`Median FPS this second: ${median}.`);
    },
    1000);

Development

After forking the repo from GitHub:

git clone https://github.com/<your-name-here>/FpsAnalyzr
cd FpsAnalyzr
npm install
npm run setup
npm run verify

• npm run setup creates a few auto-generated setup files locally.
• npm run verify builds, lints, and runs tests.

Building

npm run watch

Source files are written under src/ in TypeScript and compile in-place to JavaScript files. npm run watch will directly run the TypeScript compiler on source files in watch mode. Use it in the background while developing to keep the compiled files up-to-date.

Running Tests

npm run test

Tests are written in Mocha and Chai. Their files are written using alongside source files under src/ and named *.test.ts?. Whenever you add, remove, or rename a *.test.t* file under src/, watch will re-run npm run test:setup to regenerate the list of static test files in test/index.html. You can open that file in a browser to debug through the tests.