diff --git a/docs/components/stats.md b/docs/components/stats.md index 47ae21060e..340ad5c4f8 100644 --- a/docs/components/stats.md +++ b/docs/components/stats.md @@ -8,27 +8,33 @@ source_code: src/components/scene/stats.js [scene]: ../core/scene.md -The stats component displays a UI with performance-related metrics. The stats -component applies only to the [`` element][scene]. +The stats component displays a UI with performance-related metrics of your Aframe Project. The stats component applies only to the [``][scene] element. ## Example ```html ``` +It can also be written as `stats="true"` which will activate the UI and `stats="false"` to hide the UI. This version can be useful during development as it allows you to keep the component within your code for easy access. ## Metrics - **fps**: frames per second, framerate. Aim for stable 90 fps with the WebVR 1.0 API. - **requestAnimationFrame** (raf): Latency. + +Three.js -- **Memory** - **Textures**: number of three.js textures in the scene. A lower count means the scene is using less memory and sending less data to the GPU. - **Programs**: number of GLSL shaders in the scene. - **Geometries**: number of three.js geometries in the scene. A lower count means the scene is using less memory. -- **Vertices**: number of vertices in the scene. -- **Faces**: number of faces in the scene. + +Three.js -- **Render** +- **Points**: number of points (vertices) in the scene. +- **Triangles**: number of triangles (faces) in the scene. - **Calls**: number of draw calls on each frame. + +A-Frame - **Load Time**: how long it took for the scene to start rendering, in ms. - **Entities**: number of A-Frame entities.