https://github.com/iprit/three.webglstats
https://github.com/iprit/three.webglstats
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/iprit/three.webglstats
- Owner: IPRIT
- Created: 2018-06-19T20:24:59.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-06-19T20:25:07.000Z (almost 8 years ago)
- Last Synced: 2025-02-18T12:06:43.444Z (over 1 year ago)
- Language: JavaScript
- Size: 104 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
@xailabs/three-renderer-stats
========================================
FORKED FROM https://github.com/jeromeetienne/threex.rendererstats
- Allow reset by calling `update()` without passing renderer
- Published on npm
- Fix programs count (~ PR4)
========================================
It is a three.js extension to display realtime informations about ```THREE.WebGLRenderer```.
Here is a [basic example](http://jeromeetienne.github.io/threex.rendererstats/examples/basic.html). It is widely inpired from @mrdoob [stats.js](https://github.com/mrdoob/stats.js/).
It is released under MIT license.
## How To install it
Via yarn:
```javascript
yarn add @xailabs/three-renderer-stats
```
Via npm:
```javascript
npm install @xailabs/three-renderer-stats --save
```
## How To Use It
```javascript
import RendererStats from '@xailabs/three-renderer-stats';
const rendererStats = new RendererStats();
```
position it on the page with css with something along this line:
```javascript
rendererStats.domElement.style.position = 'absolute'
rendererStats.domElement.style.left = '0px'
rendererStats.domElement.style.bottom = '0px'
document.body.appendChild( rendererStats.domElement )
```
finally update it at every frame, passing the webGLRenderer reference:
```javascript
rendererStats.update(renderer);
```
update it without passing anything (or passing something falsy) to reset the displayed output:
```javascript
rendererStats.update(null);
```