Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pmndrs/detect-gpu
Classifies GPUs based on their 3D rendering benchmark score allowing the developer to provide sensible default settings for graphically intensive applications.
https://github.com/pmndrs/detect-gpu
adaptive babylonjs benchmarks browser demo detection device gpu hardware pixijs progressive-enhancement threejs webgl webgl2
Last synced: 27 days ago
JSON representation
Classifies GPUs based on their 3D rendering benchmark score allowing the developer to provide sensible default settings for graphically intensive applications.
- Host: GitHub
- URL: https://github.com/pmndrs/detect-gpu
- Owner: pmndrs
- License: mit
- Created: 2018-07-24T15:51:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T13:40:00.000Z (9 months ago)
- Last Synced: 2024-05-03T03:58:04.132Z (6 months ago)
- Topics: adaptive, babylonjs, benchmarks, browser, demo, detection, device, gpu, hardware, pixijs, progressive-enhancement, threejs, webgl, webgl2
- Language: TypeScript
- Homepage:
- Size: 9.18 MB
- Stars: 984
- Watchers: 18
- Forks: 55
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Detect GPU
[](https://badge.fury.io/js/detect-gpu)
[](https://unpkg.com/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).