# detect-gpu > Classify GPU's based on their benchmark score in order to provide an adaptive experience. Latest version **5.0.70** (published 2025-02-23) · MIT license · 0 weekly downloads ## Install ```sh npm install detect-gpu pnpm add detect-gpu yarn add detect-gpu bun add detect-gpu ``` ## Health **Score 55/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads. Negative: stale. ## Facts | | | |---|---| | Version | 5.0.70 | | Published | 2025-02-23 | | First published | 2018-07-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 956.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1212 | | Author | Tim van Scherpenzeel | | Maintainers | drcmda, timvanscherpenzeel | | Keywords | gpu, detect, webgl, webgl2, three.js, babylonjs, three, babylon, 3d, typescript, javascript | ## Links - npm: https://www.npmjs.com/package/detect-gpu - Repository: https://github.com/pmndrs/detect-gpu - Homepage: https://github.com/pmndrs/detect-gpu#readme - Issues: https://github.com/pmndrs/detect-gpu/issues - npm.io page: https://npm.io/package/detect-gpu ## Dependencies (1) - [webgl-constants](https://npm.io/package/webgl-constants.md) ^1.1.1 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 5.0.70 (latest) — 2025-02-23 - 2.0.2-rc1 (next) — 2020-10-16 - 5.0.69 — 2025-02-16 - 5.0.68 — 2025-02-09 - 5.0.67 — 2025-02-02 - 5.0.66 — 2025-01-26 - 5.0.65 — 2025-01-19 - 5.0.64 — 2025-01-12 - 5.0.63 — 2024-12-29 - 5.0.62 — 2024-12-22 - 5.0.61 — 2024-12-15 - 5.0.60 — 2024-12-08 - 5.0.59 — 2024-12-01 - 5.0.58 — 2024-11-24 - 5.0.57 — 2024-11-17 - … 199 more at https://npm.io/package/detect-gpu/versions ## README # Detect GPU [![npm version](https://badge.fury.io/js/detect-gpu.svg)](https://badge.fury.io/js/detect-gpu) [![gzip size](https://img.badgesize.io/https:/unpkg.com/detect-gpu/dist/detect-gpu.esm.js?compression=gzip)](https://unpkg.com/detect-gpu) [![install size](https://packagephobia.now.sh/badge?p=detect-gpu)](https://packagephobia.now.sh/result?p=detect-gpu) Classifies 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. ## Demo [Live demo](https://pmndrs.github.io/detect-gpu/) ## Installation By default we use the [UNPKG](https://unpkg.com) 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](https://github.com/pmndrs/detect-gpu/raw/master/benchmarks.tar.gz) and serve it from a public directory. Make sure you have [Node.js](http://nodejs.org/) installed. ```sh $ npm install detect-gpu ``` ## Usage ```ts 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` 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 ```ts getGPUTier({ /** * URL of directory where benchmark data is hosted. * * @default https://unpkg.com/detect-gpu@{version}/dist/benchmarks */ benchmarksURL?: string; /** * Optionally pass in a WebGL context to avoid creating a temporary one * internally. */ glContext?: WebGLRenderingContext | WebGL2RenderingContext; /** * Whether to fail if the system performance is low or if no hardware GPU is * available. * * @default false */ failIfMajorPerformanceCaveat?: boolean; /** * Framerate per tier for mobile devices. * * @defaultValue [0, 15, 30, 60] */ mobileTiers?: number[]; /** * Framerate per tier for desktop devices. * * @defaultValue [0, 15, 30, 60] */ desktopTiers?: number[]; /** * Optionally override specific parameters. Used mainly for testing. */ override?: { renderer?: string; /** * Override whether device is an iPad. */ isIpad?: boolean; /** * Override whether device is a mobile device. */ isMobile?: boolean; /** * Override device screen size. */ screenSize?: { width: number; height: number }; /** * Override how benchmark data is loaded */ loadBenchmarks?: (file: string) => Promise; }; }) ``` ## Support Special care has been taken to make sure all browsers that support `WebGL` are also supported by `detect-gpu` including `IE 11`. ## Changelog [Changelog](CHANGELOG.md) ## Licence My work is released under the [MIT license](https://raw.githubusercontent.com/pmndrs/detect-gpu/master/LICENSE). `detect-gpu` uses both mobile and desktop benchmarking scores from [https://gfxbench.com](https://gfxbench.com). --- _Source: https://npm.io/package/detect-gpu · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._