Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 2.41 KB

README.md

File metadata and controls

40 lines (33 loc) · 2.41 KB
Raw

Extra Stats component

npm version npm version github twitter mastodon ko-fi

This component expands on the built-in stats component with additional stats. It's intended for debugging and development purposes only.

Checkout the example: Online Demo | Source

Usage

Load the script from npm or add the following script tag:

<script src="https://cdn.jsdelivr.net/npm/@fern-solutions/aframe-extra-stats/dist/extra-stats.umd.min.js"></script>

The extra-stats component should be added to an <a-scene> and is intended to replace the stats component. Make sure to only add one or the other to the <a-scene>. Example:

<a-scene extra-stats>
    <!-- scene -->
</a-scene>

Properties can be used to enable or disable groups. For example, the following results in a stats panel similar to the built-in one:

<a-scene extra-stats="three: true; aframe: true; three-alloc: false">
    <!-- scene -->
</a-scene>

Note: The properties can't be changed after initialization, as they determin with which plugins rStats is initialized.

Properties

Name Type Default Description
three boolean true Show the Three.js related stats
aframe boolean true Show the A-Frame related stats ("Load Time" and "Entities")
three-alloc boolean true Show the Three.js allocations of various types (Vectors, Matrices, Quaternions and Colors)