Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kainino0x authored Jun 11, 2024
1 parent 0dc92bd commit b30c517
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# WebGPU headers
# WebGPU Headers

This repository contains C headers equivalent to the [WebGPU](https://gpuweb.github.io/gpuweb/) API and (soon) documentation on the native specificities of the headers.
This repository contains C headers equivalent to the [WebGPU](https://gpuweb.github.io/gpuweb/) API and documentation on the native specificities of the headers.

**This header is NOT STABLE yet, and the documentation is very much a work in progress!**

All of the API is defined in the [webgpu.h](./webgpu.h) header file.
**[Read the documentation here!](https://webgpu-native.github.io/webgpu-headers/)**

## Why?

While WebGPU is a JavaScript API made for the Web, it is a good tradeoff of ergonomic, efficient and portable graphics API.
Almost all of its concepts are not specific to the Web platform and the headers replicate them exactly, while adding capabilities to interact with native concepts (like windows).

All of the API is defined in the [webgpu.h](./webgpu.h) header.

Implementations of this header include:

- [Dawn](https://dawn.googlesource.com/dawn), Chromium's C++ WebGPU implementation library
- [wgpu-native](https://github.com/gfx-rs/wgpu-native), Firefox's Rust WebGPU implementation library
- [Dawn](https://dawn.googlesource.com/dawn), the C++ WebGPU implementation used in Chromium
- [wgpu-native](https://github.com/gfx-rs/wgpu-native), C bindings to [wgpu](https://github.com/gfx-rs/wgpu), the Rust WebGPU implementation used in Firefox
- [Emscripten](https://github.com/emscripten-core/emscripten/blob/main/src/library_webgpu.js) translates [webgpu.h](./webgpu.h) calls to JavaScript WebGPU calls when compiling to WASM

## Details
Expand Down

0 comments on commit b30c517

Please sign in to comment.