webgl-stats v0.2.2

webgl-stats

If you are looking for a UI representation of this stats you should take a look at: https://github.com/fernandojsg/webg-stats-ui

Keep tracks of the number of WebGL calls on your application by hooking the WebGL1 and WebGL2 APIs:

• DrawCalls:
  • DrawArrays
  • DrawArraysInstanced
  • DrawElements
  • DrawElementsInstanced
• numFaces
• numVertices
• numPoints
• useProgram
• bindTextures

Installation

NPM

Install via NPM:

npm install --save webgl-stats

Then import to use it:

import WEBGLSTATS from 'webgl-stats';

or

WEBGLSTATS = require('webgl-stats');

Browser

<script src="unpkg.com/webgl-stats@0.2.0/dist/webgl-stats.js"></script>

Usage

webgl-stats will hook the WebGL1 and WebGL2 automatically, but you should provide your context once you have created it in your app, and before you start using it:

var canvas = document.getElementById('canvas');
var ctx = canvas.getContext('2d');

WEBGLSTATS.setupExtensions(ctx);

On every frame you should call frameStart before your render call and frameEnd after that.

function animate() {
  requestAnimationFrame( animate );
  
  WEBGLSTATS.frameStart();
  render();
  WEBGLSTATS.frameEnd();
  
  showStats();
}

After that you could query the current frame data or the accumulated stats:

• getCurrentData():

{
  "numDrawCalls": 0,

  "numDrawArraysCalls": 0,
  "numDrawArraysInstancedCalls": 0,
  "numDrawElementsCalls": 0,
  "numDrawElementsInstancedCalls": 0,

  "numUseProgramCalls": 0,
  "numFaces": 0,
  "numVertices": 0,
  "numPoints": 0,
  "numBindTextures": 0
}

• getSummary():

{
  "drawCalls": {
    "min": 0,
    "max": 0,
    "avg": 0,
    "standard_deviation": 0
  },
  "useProgramCalls": {
    "min": 0,
    "max": 0,
    "avg": 0,
    "standard_deviation": 0
  },
  "faces": {
    "min": 0,
    "max": 0,
    "avg": 0,
    "standard_deviation": 0
  },
  "vertices": {
    "min": 0,
    "max": 0,
    "avg": 0,
    "standard_deviation": 0
  },
  "bindTextures": {
    "min": 0,
    "max": 0,
    "avg": 0,
    "standard_deviation": 0
  }
}