Skip to content

Latest commit

 

History

History

time-fps-overlay

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

@genart-api/time-fps-overlay

npm version npm downloads Mastodon Follow

GenArtAPI time provider for development purposes, which collects FPS samples and injects a canvas overlay to visualize recent frame rates and compute moving averages. The visualization can be configured via provided options.

See main project README for further info about GenArtAPI time providers.

Usage

yarn add @genart-api/time-fps-overlay

# create dest dir
mkdir -p lib

# copy files
cp node_modules/@genart-api/time-fps-overlay/*.min.js lib

In your HTML wrapper, add the following script tags to the <head> to load the core GenArtAPI and the Layer platform adapter:

<script src="./lib/genart.min.js"></script>
<script src="./lib/time-fps-overlay.min.js"></script>
<script>
	$genart.setTimeProvider(timeProviderFPSOverlay({}));
</script>

License

© 2024 - 2025 Karsten Schmidt // MIT License