A simple FPS meter that measures average FPS and runs a callback when it dips below a certain level.
npm install @wesbos/fps-meterA simple FPS meter that measures average FPS and runs a callback when it dips below a certain level.
Useful for turning off expensive animations or compositing that cause FPS to lag.
``bash`
npm install @wesbos/fps-meter
`typescript
import FPSMeter from "@wesbos/fps-meter";
// Create a new FPS meter instance
const fpsMeter = new FPSMeter();
// Optional: Set a callback for when FPS drops below 45
fpsMeter.setLowFPSCallback((fps) => {
console.log(Low FPS detected: ${fps});
});
// The meter will automatically start measuring FPS
// You can also manually start it with:
fpsMeter.start();
// Get the current average FPS
const averageFPS = fpsMeter.getAverageFPS();
`
`typescript`
new FPSMeter(totalFrames?: number)
- totalFrames: Number of frames to average (default: 60)
- start(): Start measuring FPSgetAverageFPS()
- : Returns the current average FPS or null if not enough frames have been measuredsetLowFPSCallback(callback: (fps: number) => void)`: Set a callback to be called when FPS drops below 45
-
MIT