foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-12-22 07:14:47 -05:00
Code Issues Packages 1 Wiki Activity
denoland-deno/ext/webgpu
History
Divy Srivastava 40febd9dd1
feat:: External webgpu surfaces / BYOW (#21835) 
This PR contains the implementation of the External webgpu surfaces /
BYOW proposal. BYOW stands for "Bring your own window".

Closes #21713 

Adds `Deno.UnsafeWindowSurface` ( `--unstable-webgpu` API) to the `Deno`
namespace:

```typescript
class UnsafeWindowSurface {
  constructor(
    system: "cocoa" | "x11" | "win32",
    winHandle: Deno.PointerValue,
    displayHandle: Deno.PointerValue | null
  );
  
  getContext(type: "webgpu"): GPUCanvasContext;

  present(): void;
}
```

For the initial pass, I've opted to support the three major windowing
systems. The parameters correspond to the table below:
| system                      | winHandle  | displayHandle |
| -----------------     | ----------   | ------- |
| "cocoa" (macOS)    | `NSView*`       | - |
| "win32" (Windows) | `HWND`         | `HINSTANCE` |
| "x11" (Linux)            | Xlib `Window` | Xlib `Display*` |

Ecosystem support:

- [x] deno_sdl2 (sdl2) -
[mod.ts#L1209](7e177bc652/mod.ts (L1209))
- [x] dwm (glfw) - https://github.com/deno-windowing/dwm/issues/29
- [ ] pane (winit)

<details>
<summary>Example</summary>

```typescript
// A simple clear screen pass, colors based on mouse position.

import { EventType, WindowBuilder } from "https://deno.land/x/sdl2@0.7.0/mod.ts";

const window = new WindowBuilder("sdl2 + deno + webgpu", 640, 480).build();
const [system, windowHandle, displayHandle] = window.rawHandle();

const adapter = await navigator.gpu.requestAdapter();
const device = await adapter.requestDevice();

const context = Deno.createWindowSurface(system, windowHandle, displayHandle);

context.configure({
  device: device,
  format: "bgra8unorm",
  height: 480,
  width: 640,
});

let r = 0.0;
let g = 0.0;
let b = 0.0;

for (const event of window.events()) {
  if (event.type === EventType.Quit) {
    break;
  } else if (event.type === EventType.Draw) {
    const textureView = context.getCurrentTexture().createView();

    const renderPassDescriptor: GPURenderPassDescriptor = {
      colorAttachments: [
        {
          view: textureView,
          clearValue: { r, g, b, a: 1.0 },
          loadOp: "clear",
          storeOp: "store",
        },
      ],
    };

    const commandEncoder = device.createCommandEncoder();
    const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
    passEncoder.end();

    device.queue.submit([commandEncoder.finish()]);
    Deno.presentGPUCanvasContext(context);
  }

  if (event.type === EventType.MouseMotion) {
    r = event.x / 640;
    g = event.y / 480;
    b = 1.0 - r - g;
  }
}
```

You can find more examples in the linked tracking issue.

</details>

---------

Signed-off-by: Divy Srivastava <dj.srivastava23@gmail.com>
2024-01-19 22:49:14 +05:30
..
00_init.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
01_webgpu.js refactor: use core.ensureFastOps() (#21888) 2024-01-10 15:37:25 -07:00
02_surface.js feat:: External webgpu surfaces / BYOW (#21835) 2024-01-19 22:49:14 +05:30
binding.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
buffer.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
bundle.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
byow.rs feat:: External webgpu surfaces / BYOW (#21835) 2024-01-19 22:49:14 +05:30
Cargo.toml feat:: External webgpu surfaces / BYOW (#21835) 2024-01-19 22:49:14 +05:30
command_encoder.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
compute_pass.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
error.rs chore(ext/webgpu): include GPUCanvasContext in snapshot (#21773) 2024-01-05 19:55:01 +05:30
lib.rs feat:: External webgpu surfaces / BYOW (#21835) 2024-01-19 22:49:14 +05:30
LICENSE.md feat: bring back WebGPU (#20812) 2023-12-09 01:19:16 +01:00
pipeline.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
queue.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
README.md feat: bring back WebGPU (#20812) 2023-12-09 01:19:16 +01:00
render_pass.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
sampler.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
shader.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
surface.rs chore(ext/webgpu): include GPUCanvasContext in snapshot (#21773) 2024-01-05 19:55:01 +05:30
texture.rs chore: update copyright to 2024 (#21753) 2024-01-01 19:58:21 +00:00
webgpu.idl feat: bring back WebGPU (#20812) 2023-12-09 01:19:16 +01:00

README.md

deno_webgpu

This op crate implements the WebGPU API as defined in https://gpuweb.github.io/gpuweb/ in Deno. The implementation targets the spec draft as of October 4, 2023. The spec is still very much in flux. This op crate tries to stay up to date with the spec, but is constrained by the features implemented in our GPU backend library wgpu.

The spec is still very bare bones, and is still missing many details. As the spec becomes more concrete, we will implement to follow the spec more closely.

In addition, setting the DENO_WEBGPU_TRACE environmental variable will output a wgpu trace to the specified directory.

For testing this op crate will make use of the WebGPU conformance tests suite, running through our WPT runner. This will be used to validate implementation conformance.

GitHub CI doesn't run with GPUs, so testing relies on software like DX WARP & Vulkan lavapipe. Currently only using DX WARP works, so tests are only run on Windows.

Links

Specification: https://gpuweb.github.io/gpuweb/

Design documents: https://github.com/gpuweb/gpuweb/tree/main/design

Conformance tests suite: https://github.com/gpuweb/cts

WebGPU examples for Deno: https://github.com/crowlKats/webgpu-examples

wgpu-users matrix channel: https://matrix.to/#/#wgpu-users:matrix.org