-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[docs] Update stats.md #5378
base: master
Are you sure you want to change the base?
[docs] Update stats.md #5378
Conversation
Added another way to write stats (stats="true") and reorganized the Metrics.
@@ -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 [`<a-scene>` element][scene]. | |||
The stats component displays a UI with performance-related metrics of your Aframe Project. The stats component applies only to the [`<a-scene>`][scene] element. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure mentioning A-Frame here adds much value. Just more verbose
|
||
## Metrics | ||
|
||
- **fps**: frames per second, framerate. Aim for stable 90 fps with the WebVR 1.0 API. | ||
- **requestAnimationFrame** (raf): Latency. | ||
|
||
Three.js -- **Memory** |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure mentioning Three.js here adds much value.
|
||
## Example | ||
|
||
```html | ||
<a-scene stats></a-scene> | ||
``` | ||
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be documented in a values section like this one https://aframe.io/docs/1.4.0/components/gltf-model.html#values
Thanks. I left some comments. |
Description:
Added another way to write stats (stats="true") and reorganized the Metrics. I hope this is helpful.
Changes proposed: