blob: 62ee1985919b9d5e6fc73fa70922ca1dc23773e9 [file] [log] [blame] [view]
Austin Eng165c1c02023-11-09 23:12:35 +00001<div align="center">
2 <img
3 title="Dawn's logo"
4 alt="Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo."
5 src="docs/imgs/dawn_logo_notext.png"
6 width="50%">
7
8 ![Build Status](https://github.com/google/dawn/actions/workflows/ci.yml/badge.svg?branch=main&event=push)
9 [![Matrix Space](https://img.shields.io/static/v1?label=Space&message=%23webgpu-dawn&color=blue&logo=matrix)](https://matrix.to/#/#webgpu-dawn:matrix.org)
10</div>
Corentin Wallez749e1442021-09-02 09:51:40 +000011
Corentin Wallez3b246682018-08-16 13:50:49 +020012# Dawn, a WebGPU implementation
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040013
Austin Eng165c1c02023-11-09 23:12:35 +000014Dawn is an open-source and cross-platform implementation of the [WebGPU](https://webgpu.dev) standard.
dan sinclairfb5a4922022-04-19 22:25:45 +000015More 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 Wallez1d6250d2019-12-05 11:01:41 +000016Dawn is meant to be integrated as part of a larger system and is the underlying implementation of WebGPU in Chromium.
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040017
Corentin Wallez3b246682018-08-16 13:50:49 +020018Dawn provides several WebGPU building blocks:
19 - **WebGPU C/C++ headers** that applications and other building blocks use.
Corentin Wallez1d6250d2019-12-05 11:01:41 +000020 - The `webgpu.h` version that Dawn implements.
21 - A C++ wrapper for the `webgpu.h`.
Corentin Wallezd072e112022-08-09 14:09:00 +000022 - **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 Wallez3b246682018-08-16 13:50:49 +020023 - **A client-server implementation of WebGPU** for applications that are in a sandbox without access to native drivers
Corentin Wallezd072e112022-08-09 14:09:00 +000024 - **Tint** is a compiler for the WebGPU Shader Language (WGSL) that can be used in standalone to convert shaders from and to WGSL.
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040025
Corentin Wallez1d6250d2019-12-05 11:01:41 +000026Helpful links:
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040027
dan sinclair5ee22f32022-04-28 16:25:43 +000028 - [Dawn bug tracker](https://bugs.chromium.org/p/dawn/issues/entry) if you find issues with Dawn.
29 - [Tint bug tracker](https://bugs.chromium.org/p/tint/issues/entry) if you find issues with Tint.
Corentin Wallez1d6250d2019-12-05 11:01:41 +000030 - [Dawn's mailing list](https://groups.google.com/forum/#!members/dawn-graphics) for other discussions related to Dawn.
31 - [Dawn's source code](https://dawn.googlesource.com/dawn)
Corentin Wallezd05e5322020-09-11 10:38:46 +000032 - [Dawn's Matrix chatroom](https://matrix.to/#/#webgpu-dawn:matrix.org) for live discussion around contributing or using Dawn.
Corentin Wallez094d1d42020-04-24 12:38:13 +000033 - [WebGPU's Matrix chatroom](https://matrix.to/#/#WebGPU:matrix.org)
dan sinclair5ee22f32022-04-28 16:25:43 +000034 - [Tint mirror](https://dawn.googlesource.com/tint) for standalone usage.
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040035
Corentin Wallez1d6250d2019-12-05 11:01:41 +000036## Documentation table of content
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040037
Corentin Wallez1d6250d2019-12-05 11:01:41 +000038Developer documentation:
Corentin Wallezf07e3bd2017-04-20 14:38:20 -040039
Ben Clayton26c31f62022-01-27 18:33:47 +000040 - [Dawn overview](docs/dawn/overview.md)
dan sinclair5ee22f32022-04-28 16:25:43 +000041 - [Building](docs/building.md)
42 - [Contributing](CONTRIBUTING.md)
43 - [Code of Conduct](CODE_OF_CONDUCT.md)
Ben Clayton26c31f62022-01-27 18:33:47 +000044 - [Testing Dawn](docs/dawn/testing.md)
David Neto750120f2023-09-19 21:15:38 +000045 - [Testing Tint](docs/tint/testing.md)
Ben Clayton26c31f62022-01-27 18:33:47 +000046 - [Debugging Dawn](docs/dawn/debugging.md)
47 - [Dawn's infrastructure](docs/dawn/infra.md)
48 - [Dawn errors](docs/dawn/errors.md)
dan sinclair5ee22f32022-04-28 16:25:43 +000049 - [Tint experimental extensions](docs/tint/experimental_extensions.md)
50
David Netob5bced22018-11-13 09:10:37 +000051
Corentin Walleze3faaae2020-10-21 14:37:52 +000052User documentation: (TODO, figure out what overlaps with the webgpu.h docs)
David Netob5bced22018-11-13 09:10:37 +000053
Corentin Wallez3b246682018-08-16 13:50:49 +020054## License
55
Austin Engcc2516a2023-10-17 20:57:54 +000056BSD 3-Clause License, please see [LICENSE](/LICENSE).
Corentin Wallez3b246682018-08-16 13:50:49 +020057
58## Disclaimer
59
60This is not an officially supported Google product.