Skip to content

Latest commit

 

History

History
123 lines (81 loc) · 3.93 KB

README.md

File metadata and controls

123 lines (81 loc) · 3.93 KB
Raw

webgl-gpu-power-estimation

Catering a 3d web-based experience to the power of a target platform is difficult with such a small amount of information available about the current graphics hardware. This utility aims to provide performance benchmark, clock speed, and memory information about the current hardware by guessing the type of graphics hardware using webgl UNMASKED_RENDERER_WEBGL parameter and looking it up in a cached list of hardware.

GPU benchmark and spec information scraped from videocardbenchmark.net, techpowerup.com, and notebookcheck.net.

See your hardware info here!

Matching the Graphics Hardware Name

The values from UNMASKED_RENDERER_WEBGL are irregular and relatively unpredictable. To find the corresponding hardware in the database list we

  • Check if there is a version number in the current GPU hardware name.
  • Filter the database of GPUs to those that include that version number (or to those that have no version number if none was found).
  • From that list pick the hardware the has the most matching tokens between the names.

Use

import { getDetailedInfo, getBasicInfo } from 'gpu-power-estimate';
import { database } from 'gpu-power-estimate/database';

// get the hardware information
const canvas = document.createElement('canvas');
const gl = canvas.getContext('webgl');
const basicInfo = getBasicInfo(gl);
const detailedInfo = getDetailedInfo(database, gl);

// scale the application
const capability = detailedInfo ? detailedInfo.performance : 0;
if (capability > 6000) {

    // initialize highest fidelity scene
    
} else if (capability > 3000) {

    // initialize moderately complex scene

} else {

    // initialize simplified scene

}

API

getBasicInfo

getBasicInfo( context = null : WebGLContext ) : Object | null

Returns some basic info about the hardware based on the WEBGL_debug_renderer_info extension or null if it's unavailable.

If the context is not provided then a temporary one will be created.

{
  // The full graphics hardware
  name,

  // A guess as to whether or not the hardware is integrated graphics
  integrated,

  // The raw unmasked fields returned from the extension
  unmasked: { vendor, renderer }

}

getDetailedInfo

getDetailedInfo(
	database : Object,
	contextOrCard = null : WebGLContext | string
) : Object | null

Returns more detailed hardware information based on the information in the provided database. The database is expected to be an object where the keys are the names of graphics hardware and the values are objects with detail information. A pre-made database is available in the repo at src/database.js.

If a WebGL context or card name to search is not provided then a temporary context will be created.

The pre-made database provides the following data. Fields are null if unavailable. If no card is found or WEBGL_debug_renderer_info is unavailable then null is returned.

{

  // Name of the GPU
  name,

  // Type of graphics card
  // Workstation, Desktop, Mobile, Unknown
  type,

  // The 3d and 2d performance results as provided by the
  // PassMark g3d and g2d benchmarks
  performance,

  // thermal design power
  tdp,

  // total available vram in MB
  memory,

  // clock speeds in MHz
  clock,
  memoryClock

}

Caveats

For privacy reasons the availability of the UNMASKED_RENDERER_WEBGL parameter may be disabled in which case no estimate can be provided.

References