| Ben Clayton | 26c31f6 | 2022-01-27 18:33:47 +0000 | [diff] [blame] | 1 |  |
| Corentin Wallez | 749e144 | 2021-09-02 09:51:40 +0000 | [diff] [blame] | 2 | |
| Corentin Wallez | 3b24668 | 2018-08-16 13:50:49 +0200 | [diff] [blame] | 3 | # Dawn, a WebGPU implementation |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 4 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 5 | Dawn is an open-source and cross-platform implementation of the work-in-progress [WebGPU](https://webgpu.dev) standard. |
| dan sinclair | fb5a492 | 2022-04-19 22:25:45 +0000 | [diff] [blame] | 6 | More precisely it implements [`webgpu.h`](https://github.com/webgpu-native/webgpu-headers/blob/main/webgpu.h) that is a one-to-one mapping with the WebGPU IDL. |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 7 | Dawn is meant to be integrated as part of a larger system and is the underlying implementation of WebGPU in Chromium. |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 8 | |
| Corentin Wallez | 3b24668 | 2018-08-16 13:50:49 +0200 | [diff] [blame] | 9 | Dawn provides several WebGPU building blocks: |
| 10 | - **WebGPU C/C++ headers** that applications and other building blocks use. |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 11 | - The `webgpu.h` version that Dawn implements. |
| 12 | - A C++ wrapper for the `webgpu.h`. |
| Corentin Wallez | d072e11 | 2022-08-09 14:09:00 +0000 | [diff] [blame] | 13 | - **A "native" implementation of WebGPU** using platforms' GPU APIs: D3D12, Metal, Vulkan and OpenGL. See [per API support](docs/support.md) for more details. |
| Corentin Wallez | 3b24668 | 2018-08-16 13:50:49 +0200 | [diff] [blame] | 14 | - **A client-server implementation of WebGPU** for applications that are in a sandbox without access to native drivers |
| Corentin Wallez | d072e11 | 2022-08-09 14:09:00 +0000 | [diff] [blame] | 15 | - **Tint** is a compiler for the WebGPU Shader Language (WGSL) that can be used in standalone to convert shaders from and to WGSL. |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 16 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 17 | Helpful links: |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 18 | |
| dan sinclair | 5ee22f3 | 2022-04-28 16:25:43 +0000 | [diff] [blame] | 19 | - [Dawn bug tracker](https://bugs.chromium.org/p/dawn/issues/entry) if you find issues with Dawn. |
| 20 | - [Tint bug tracker](https://bugs.chromium.org/p/tint/issues/entry) if you find issues with Tint. |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 21 | - [Dawn's mailing list](https://groups.google.com/forum/#!members/dawn-graphics) for other discussions related to Dawn. |
| 22 | - [Dawn's source code](https://dawn.googlesource.com/dawn) |
| Corentin Wallez | d05e532 | 2020-09-11 10:38:46 +0000 | [diff] [blame] | 23 | - [Dawn's Matrix chatroom](https://matrix.to/#/#webgpu-dawn:matrix.org) for live discussion around contributing or using Dawn. |
| Corentin Wallez | 094d1d4 | 2020-04-24 12:38:13 +0000 | [diff] [blame] | 24 | - [WebGPU's Matrix chatroom](https://matrix.to/#/#WebGPU:matrix.org) |
| dan sinclair | 5ee22f3 | 2022-04-28 16:25:43 +0000 | [diff] [blame] | 25 | - [Tint mirror](https://dawn.googlesource.com/tint) for standalone usage. |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 26 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 27 | ## Documentation table of content |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 28 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 29 | Developer documentation: |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 30 | |
| Ben Clayton | 26c31f6 | 2022-01-27 18:33:47 +0000 | [diff] [blame] | 31 | - [Dawn overview](docs/dawn/overview.md) |
| dan sinclair | 5ee22f3 | 2022-04-28 16:25:43 +0000 | [diff] [blame] | 32 | - [Building](docs/building.md) |
| 33 | - [Contributing](CONTRIBUTING.md) |
| 34 | - [Code of Conduct](CODE_OF_CONDUCT.md) |
| Ben Clayton | 26c31f6 | 2022-01-27 18:33:47 +0000 | [diff] [blame] | 35 | - [Testing Dawn](docs/dawn/testing.md) |
| 36 | - [Debugging Dawn](docs/dawn/debugging.md) |
| 37 | - [Dawn's infrastructure](docs/dawn/infra.md) |
| 38 | - [Dawn errors](docs/dawn/errors.md) |
| dan sinclair | 5ee22f3 | 2022-04-28 16:25:43 +0000 | [diff] [blame] | 39 | - [Tint experimental extensions](docs/tint/experimental_extensions.md) |
| 40 | |
| David Neto | b5bced2 | 2018-11-13 09:10:37 +0000 | [diff] [blame] | 41 | |
| Corentin Wallez | e3faaae | 2020-10-21 14:37:52 +0000 | [diff] [blame] | 42 | User documentation: (TODO, figure out what overlaps with the webgpu.h docs) |
| David Neto | b5bced2 | 2018-11-13 09:10:37 +0000 | [diff] [blame] | 43 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 44 | ## Status |
| Corentin Wallez | f07e3bd | 2017-04-20 14:38:20 -0400 | [diff] [blame] | 45 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 46 | (TODO) |
| Corentin Wallez | 51108e0 | 2018-10-08 13:51:18 +0000 | [diff] [blame] | 47 | |
| Corentin Wallez | 3b24668 | 2018-08-16 13:50:49 +0200 | [diff] [blame] | 48 | ## License |
| 49 | |
| Corentin Wallez | 1d6250d | 2019-12-05 11:01:41 +0000 | [diff] [blame] | 50 | Apache 2.0 Public License, please see [LICENSE](/LICENSE). |
| Corentin Wallez | 3b24668 | 2018-08-16 13:50:49 +0200 | [diff] [blame] | 51 | |
| 52 | ## Disclaimer |
| 53 | |
| 54 | This is not an officially supported Google product. |
