third_party/dawn/README.md

   1 ![Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo. The text "Dawn" is written below it.](docs/imgs/dawn_logo.png "Dawn's logo")
   2
   3 # Dawn, a WebGPU implementation
   4
   5 Dawn is an open-source and cross-platform implementation of the work-in-progress [WebGPU](https://webgpu.dev) standard.
   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.
   7 Dawn is meant to be integrated as part of a larger system and is the underlying implementation of WebGPU in Chromium.
   8
   9 Dawn provides several WebGPU building blocks:
  10  - **WebGPU C/C++ headers** that applications and other building blocks use.
  11    - The `webgpu.h` version that Dawn implements.
  12    - A C++ wrapper for the `webgpu.h`.
  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.
  14  - **A client-server implementation of WebGPU** for applications that are in a sandbox without access to native drivers
  15  - **Tint** is a compiler for the WebGPU Shader Language (WGSL) that can be used in standalone to convert shaders from and to WGSL.
  16
  17 Helpful links:
  18
  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.
  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)
  23  - [Dawn's Matrix chatroom](https://matrix.to/#/#webgpu-dawn:matrix.org) for live discussion around contributing or using Dawn.
  24  - [WebGPU's Matrix chatroom](https://matrix.to/#/#WebGPU:matrix.org)
  25  - [Tint mirror](https://dawn.googlesource.com/tint) for standalone usage.
  26
  27 ## Documentation table of content
  28
  29 Developer documentation:
  30
  31  - [Dawn overview](docs/dawn/overview.md)
  32  - [Building](docs/building.md)
  33  - [Contributing](CONTRIBUTING.md)
  34  - [Code of Conduct](CODE_OF_CONDUCT.md)
  35  - [Testing Dawn](docs/dawn/testing.md)
  36  - [Testing Tint](docs/tint/testing.md)
  37  - [Debugging Dawn](docs/dawn/debugging.md)
  38  - [Dawn's infrastructure](docs/dawn/infra.md)
  39  - [Dawn errors](docs/dawn/errors.md)
  40  - [Tint experimental extensions](docs/tint/experimental_extensions.md)
  41
  42
  43 User documentation: (TODO, figure out what overlaps with the webgpu.h docs)
  44
  45 ## Status
  46
  47 (TODO)
  48
  49 ## License
  50
  51 BSD 3-Clause License, please see [LICENSE](/LICENSE).
  52
  53 ## Disclaimer
  54
  55 This is not an officially supported Google product.