[docs] Update stats.md #5378
Open
[docs] Update stats.md #5378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added another way to write stats (stats="true") and reorganized the Metrics.
dmarcos
reviewed
Nov 6, 2023
| @@ -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.
Not sure mentioning A-Frame here adds much value. Just more verbose
dmarcos
reviewed
Nov 6, 2023
|
|
||
| ## 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.
Not sure mentioning Three.js here adds much value.
dmarcos
reviewed
Nov 6, 2023
|
|
||
| ## 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.
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. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
Added another way to write stats (stats="true") and reorganized the Metrics. I hope this is helpful.
Changes proposed: