Detect-gpu-js NPM

Detect GPU

Detect and rate GPUs based on their 3D rendering benchmark score allowing the developer to provide sensible default settings for graphically intensive applications. Think of it like a user-agent detection for the GPU but more powerful.

This project is a maintained fork of detect-gpu project rewritten in JavaScript.

Demo

Live demo

Installation

Make sure you have Node.js installed, then:

 $ npm install detect-gpu-js

By default we use the UNPKG CDN to host the benchmark data. If you would like to serve the benchmark data yourself, download the required benchmarking data from benchmarks.tar.gz and serve it from a public directory.

Alternatively, there is the detect-gpu.bundle.js build that comes with benchmark data embedded. This however requires 300KB+ more data downloaded over the network.

Usage

import { getGPUTier } from 'detect-gpu';

(async () => {
    const gpuTier = await getGPUTier();
  
    // Example output:
    // {
    //     "tier": 1,
    //     "isMobile": false,
    //     "type": "BENCHMARK",
    //     "fps": 21,
    //     "gpu": "intel iris graphics 6100"
    // }
})();

detect-gpu-js uses rendering benchmark scores (framerate, normalized by resolution) in order to determine what tier should be assigned to the user's GPU. If no WebGLContext can be created, the GPU is blocklisted or the GPU has reported to render on less than 15 fps tier: 0 is assigned. One should provide a fallback to a non-WebGL experience.

Based on the reported fps the GPU is then classified into either tier: 1 (>= 15 fps), tier: 2 (>= 30 fps) or tier: 3 (>= 60 fps). The higher the tier the more graphically intensive workload you can offer to the user.

API

getGPUTier({
    /**
     * URL of directory where benchmark data is hosted.
     *
     * @default https://unpkg.com/detect-gpu-js@{version}/dist/benchmarks
     */
    benchmarksURL,
    /**
     * Optionally pass in a WebGL context to avoid creating a temporary one
     * internally.
     */
    glContext,
    /**
     * Whether to fail if the system performance is low or if no hardware GPU is
     * available.
     *
     * @default false
     */
    failIfMajorPerformanceCaveat,
    /**
     * Framerate per tier for mobile devices.
     *
     * @defaultValue [0, 15, 30, 60]
     */
    mobileTiers,
    /**
     * Framerate per tier for desktop devices.
     *
     * @defaultValue [0, 15, 30, 60]
     */
    desktopTiers,
    /**
     * Use HiDPI (Retina) resolution to find benchmark results.
     *
     * @defaultValue true
     */
    hidpiScreenSize,
    /**
     * Optionally override specific parameters. Used mainly for testing.
     */
    override: {
        renderer,
        /**
         * Override whether device is an iPad.
         */
        isIpad,
        /**
         * Override whether device is a mobile device.
         */
        isMobile,
        /**
         * Override device screen size.
         */
        screenSize: { width, height },
        /**
         * Override how benchmark data is loaded.
         */
        loadBenchmarks
    };
})