@pmndrs/detect-gpu 6.0.0 → 6.0.1

package/README.md

@@ -4,20 +4,50 @@
 [![npm downloads](https://img.shields.io/npm/dm/@pmndrs/detect-gpu.svg)](https://www.npmjs.com/package/@pmndrs/detect-gpu)
 [![gzip size](https://img.badgesize.io/https:/unpkg.com/@pmndrs/detect-gpu/dist/index.mjs?compression=gzip)](https://unpkg.com/@pmndrs/detect-gpu)
 
+> **Migrating from `detect-gpu`?** This package has moved to `@pmndrs/detect-gpu`. Update your imports:
+>
+> ```diff
+> - import { getGPUTier } from 'detect-gpu';
+> + import { getGPUTier } from '@pmndrs/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.
 
+> **Note:** Our benchmark data source ([gfxbench.com](https://gfxbench.com)) stopped updating in December 2025. The current data remains accurate for existing GPUs, but we are exploring alternative data sources for future updates. See [#132](https://github.com/pmndrs/detect-gpu/issues/132) for progress.
+
 ## 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.
+```sh
+pnpm add @pmndrs/detect-gpu
+```
 
 ```sh
 npm install @pmndrs/detect-gpu
 ```
 
+```sh
+yarn add @pmndrs/detect-gpu
+```
+
+## Self-hosting benchmark data
+
+By default benchmark data is loaded from the [UNPKG](https://unpkg.com) CDN (`https://unpkg.com/@pmndrs/detect-gpu@{version}/dist/benchmarks`). To serve it yourself (e.g. for offline environments, strict CSP, or to avoid a third-party CDN):
+
+1. Download [benchmarks.tar.gz](https://github.com/pmndrs/detect-gpu/raw/master/benchmarks.tar.gz) and extract it into a publicly served directory — for example `public/benchmarks/` in your app.
+2. Point `getGPUTier` at that URL via the `benchmarksURL` option:
+
+```ts
+const gpuTier = await getGPUTier({
+  benchmarksURL: '/benchmarks',
+});
+```
+
+The directory must be served at the exact URL passed in — `detect-gpu` appends filenames like `/benchmarks-d-*.json` to it when fetching.
+
 ## Usage
 
 ```ts
@@ -39,6 +69,21 @@ const gpuTier = await getGPUTier();
 
 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.
 
+## Result types
+
+`getGPUTier()` returns a `type` field indicating how the result was produced:
+
+| `type`                   | Meaning                                                                             |
+| ------------------------ | ----------------------------------------------------------------------------------- |
+| `BENCHMARK`              | Matched a benchmark entry; `fps` reflects the measured framerate for that GPU.      |
+| `FALLBACK`               | Renderer recognised but no benchmark match found. `tier` is a conservative default. |
+| `BENCHMARK_FETCH_FAILED` | Benchmark fetch failed (CDN outage, strict CSP, offline, etc.). Safe to retry.      |
+| `BLOCKLISTED`            | Renderer is on a known-bad list (drivers with severe issues). `tier` is always 0.   |
+| `WEBGL_UNSUPPORTED`      | No WebGL context could be created. `tier` is always 0.                              |
+| `SSR`                    | Running server-side — no `window`, detection skipped.                               |
+
+The `fps` field is populated only for `BENCHMARK` results. All other `type` values leave `fps` as `undefined`.
+
 ## API
 
 ```ts
@@ -46,7 +91,7 @@ getGPUTier({
   /**
    * URL of directory where benchmark data is hosted.
    *
-   * @default https://unpkg.com/detect-gpu@{version}/dist/benchmarks
+   * @default https://unpkg.com/@pmndrs/detect-gpu@{version}/dist/benchmarks
    */
   benchmarksURL?: string;
   /**
@@ -100,7 +145,7 @@ getGPUTier({
 
 ## Requirements
 
-- Node.js 18+
+- Node.js 24+
 - ESM only (CommonJS is not supported)
 
 ## Support

package/dist/benchmarks/d-adreno.json

@@ -1 +1,252 @@
-["5",["qualcomm adreno 540","540","540 adreno qualcomm",0,[[1919,1279,19]]],["qualcomm adreno 540 gpu","540","540 adreno gpu qualcomm",0,[[1919,1279,24]]],["qualcomm adreno 618 gpu","618","618 adreno gpu qualcomm",0,[[1920,1080,20]]],["qualcomm adreno 630 gpu","630","630 adreno gpu qualcomm",0,[[1920,1080,21]]],["qualcomm adreno 675 gpu","675","675 adreno gpu qualcomm",0,[[1920,1080,58]]],["qualcomm adreno 680 gpu","680","680 adreno gpu qualcomm",0,[[2880,1920,24]]],["qualcomm adreno 685 gpu","685","685 adreno gpu qualcomm",0,[[1920,1080,28],[2560,1600,58]]],["qualcomm adreno 690 gpu","690","690 adreno gpu qualcomm",0,[[1920,1080,60],[1920,1280,28]]],["qualcomm adreno 7c+ gen 3","7","3 7c+ adreno gen qualcomm",0,[[1920,1080,44]]],["qualcomm adreno 8cx gen 3","8","3 8cx adreno gen qualcomm",0,[[1920,1080,22],[1920,1200,60]]],["qualcomm adreno 8cx gen 4","8","4 8cx adreno gen qualcomm",0,[[2880,1800,60]]],["qualcomm adreno x1-45 gpu","1","adreno gpu qualcomm x1-45",0,[[2880,1800,58]]],["qualcomm mi pad 5 adreno 640 gpu","5","5 640 adreno gpu mi pad qualcomm",0,[[2560,1600,34]]],["qualcomm snapdragon x elite - x1e78100 - qualcomm adreno gpu","1","- adreno elite gpu qualcomm snapdragon x x1e78100",0,[[2880,1620,115]]],["qualcomm snapdragon x elite - x1e80100 - qualcomm adreno gpu","1","- adreno elite gpu qualcomm snapdragon x x1e80100",0,[[2496,1664,60]]],["qualcomm snapdragon x elite - x1e84100 - qualcomm adreno gpu","1","- adreno elite gpu qualcomm snapdragon x x1e84100",0,[[2880,1800,60]]]]
+[
+  "6",
+  [
+    "qualcomm adreno 540",
+    "540",
+    "540 adreno qualcomm",
+    0,
+    [
+      [
+        1919,
+        1279,
+        18
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 540 gpu",
+    "540",
+    "540 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1919,
+        1279,
+        24
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 618 gpu",
+    "618",
+    "618 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        19
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 630 gpu",
+    "630",
+    "630 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        20
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 675 gpu",
+    "675",
+    "675 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        58
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 680 gpu",
+    "680",
+    "680 adreno gpu qualcomm",
+    0,
+    [
+      [
+        2880,
+        1920,
+        24
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 685 gpu",
+    "685",
+    "685 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        23
+      ],
+      [
+        2560,
+        1600,
+        57
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 690 gpu",
+    "690",
+    "690 adreno gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        59
+      ],
+      [
+        1920,
+        1280,
+        28
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 7c gen 3 gpu",
+    "7",
+    "3 7c adreno gen gpu qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        48
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 7c+ gen 3",
+    "7",
+    "3 7c+ adreno gen qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        40
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 8cx gen 3",
+    "8",
+    "3 8cx adreno gen qualcomm",
+    0,
+    [
+      [
+        1920,
+        1080,
+        21
+      ],
+      [
+        1920,
+        1200,
+        59
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno 8cx gen 4",
+    "8",
+    "4 8cx adreno gen qualcomm",
+    0,
+    [
+      [
+        2880,
+        1800,
+        60
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno x1-45 gpu",
+    "1",
+    "adreno gpu qualcomm x1-45",
+    0,
+    [
+      [
+        2880,
+        1800,
+        80
+      ]
+    ]
+  ],
+  [
+    "qualcomm adreno x1-85 gpu",
+    "1",
+    "adreno gpu qualcomm x1-85",
+    0,
+    [
+      [
+        1920,
+        1080,
+        60
+      ]
+    ]
+  ],
+  [
+    "qualcomm mi pad 5 adreno 640 gpu",
+    "5",
+    "5 640 adreno gpu mi pad qualcomm",
+    0,
+    [
+      [
+        2560,
+        1600,
+        34
+      ]
+    ]
+  ],
+  [
+    "qualcomm snapdragon x elite - x1e78100 - qualcomm adreno gpu",
+    "1",
+    "- adreno elite gpu qualcomm snapdragon x x1e78100",
+    0,
+    [
+      [
+        2880,
+        1620,
+        115
+      ]
+    ]
+  ],
+  [
+    "qualcomm snapdragon x elite - x1e80100 - qualcomm adreno gpu",
+    "1",
+    "- adreno elite gpu qualcomm snapdragon x x1e80100",
+    0,
+    [
+      [
+        2496,
+        1664,
+        60
+      ]
+    ]
+  ],
+  [
+    "qualcomm snapdragon x elite - x1e84100 - qualcomm adreno gpu",
+    "1",
+    "- adreno elite gpu qualcomm snapdragon x x1e84100",
+    0,
+    [
+      [
+        2880,
+        1800,
+        60
+      ]
+    ]
+  ]
+]