mirror of
https://github.com/visgl/luma.gl.git
synced 2025-12-08 17:36:19 +00:00
41 lines
1.2 KiB
Markdown
41 lines
1.2 KiB
Markdown
# Overview
|
|
|
|
## WebGPU Device Adapter
|
|
|
|
This module contains the WebGPU adapter for the "abstract" luma.gl API (`@luma.gl/core`).
|
|
|
|
Simply importing `@luma.gl/webgpu` installs the adapter and enables WebGPU devices to
|
|
be created using `luma.createDevice(...)`:
|
|
|
|
```typescript
|
|
import {luma} from '@luma.gl/core';
|
|
import '@luma.gl/webgpu'; // Installs the WebGPUDevice adapter
|
|
|
|
const device = await luma.createDevice({type: 'webgpu', canvas: ...});
|
|
|
|
// Resources can now be created
|
|
const buffer = device.createBuffer(...);
|
|
```
|
|
|
|
To use a luma.gl WebGPU `Device` with raw WebGPU calls, the application needs to access
|
|
the `GPUDevice`. The raw WebGPU handle is available on the `WebGPUDevice` subclass:
|
|
|
|
```typescript
|
|
// @ts-expect-error
|
|
const gl = device.handle;
|
|
```
|
|
|
|
With a bit more work, typescript users can retrieve the `WebGLRenderingContext`
|
|
without ignoring type errors:
|
|
|
|
```typescript
|
|
import {Device, cast} from '@luma.gl/core';
|
|
import {WebGPUDevice} from '@luma.gl/webgpu'; // Installs the WebGPUDevice adapter
|
|
|
|
function f(device: Device) {
|
|
const webgpuDevice = device as WebGPUDevice;
|
|
const gpuDevice: GPUDevice = webgpuDevice.handle; // Get underlying WebGPU device
|
|
...
|
|
}
|
|
```
|