Google Git
Sign in
dawn / dawn / 66ab67de97b3251445d5992290c6d2888c45bda9 / . / README.md
blob: 877ea2e9c7b2e38de96175f57c446ddad96619f8 [file] [log] [blame] [view]
Austin Eng165c1c02023-11-09 23:12:35 +0000[diff] [blame]1<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 +0000[diff] [blame]11
Corentin Wallez3b246682018-08-16 13:50:49 +0200[diff] [blame]12# Dawn, a WebGPU implementation
Corentin Wallezf07e3bd2017-04-20 14:38:20 -0400[diff] [blame]13
Austin Eng165c1c02023-11-09 23:12:35 +0000[diff] [blame]14Dawn is an open-source and cross-platform implementation of the [WebGPU](https://webgpu.dev) standard.
dan sinclairfb5a4922022-04-19 22:25:45 +0000[diff] [blame]15More 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 +0000[diff] [blame]16Dawn 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 -0400[diff] [blame]17
Corentin Wallez3b246682018-08-16 13:50:49 +0200[diff] [blame]18Dawn provides several WebGPU building blocks:
19 - **WebGPU C/C++ headers** that applications and other building blocks use.
Corentin Wallez1d6250d2019-12-05 11:01:41 +0000[diff] [blame]20 - The `webgpu.h` version that Dawn implements.
21 - A C++ wrapper for the `webgpu.h`.
Corentin Wallezd072e112022-08-09 14:09:00 +0000[diff] [blame]22 - **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 +0200[diff] [blame]23 - **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 +0000[diff] [blame]24 - **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 -0400[diff] [blame]25
Corentin Wallez1d6250d2019-12-05 11:01:41 +0000[diff] [blame]26Helpful links:
Corentin Wallezf07e3bd2017-04-20 14:38:20 -0400[diff] [blame]27
Austin Eng64e5d262024-05-22 23:28:07 +0000[diff] [blame]28 - [Dawn bug tracker](https://issues.chromium.org/savedsearches/6783309) if you find issues with Dawn. Create a new issue [here](https://issues.chromium.org/issues/new?noWizard=true&component=1570784).
29 - [Tint bug tracker](https://issues.chromium.org/savedsearches/6783217) if you find issues with Tint. Create a new issue [here](https://issues.chromium.org/issues/new?noWizard=true&component=1571063).
Corentin Wallez1d6250d2019-12-05 11:01:41 +0000[diff] [blame]30 - [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 +0000[diff] [blame]32 - [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 +0000[diff] [blame]33 - [WebGPU's Matrix chatroom](https://matrix.to/#/#WebGPU:matrix.org)
dan sinclair5ee22f32022-04-28 16:25:43 +0000[diff] [blame]34 - [Tint mirror](https://dawn.googlesource.com/tint) for standalone usage.
Corentin Wallezf07e3bd2017-04-20 14:38:20 -0400[diff] [blame]35
Corentin Wallez1d6250d2019-12-05 11:01:41 +0000[diff] [blame]36## Documentation table of content
Corentin Wallezf07e3bd2017-04-20 14:38:20 -0400[diff] [blame]37
Corentin Wallez1d6250d2019-12-05 11:01:41 +0000[diff] [blame]38Developer documentation:
Corentin Wallezf07e3bd2017-04-20 14:38:20 -0400[diff] [blame]39
Ben Clayton26c31f62022-01-27 18:33:47 +0000[diff] [blame]40 - [Dawn overview](docs/dawn/overview.md)
dan sinclair5ee22f32022-04-28 16:25:43 +0000[diff] [blame]41 - [Building](docs/building.md)
42 - [Contributing](CONTRIBUTING.md)
43 - [Code of Conduct](CODE_OF_CONDUCT.md)
Ben Clayton26c31f62022-01-27 18:33:47 +0000[diff] [blame]44 - [Testing Dawn](docs/dawn/testing.md)
David Neto750120f2023-09-19 21:15:38 +0000[diff] [blame]45 - [Testing Tint](docs/tint/testing.md)
Ben Clayton26c31f62022-01-27 18:33:47 +0000[diff] [blame]46 - [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 +0000[diff] [blame]49 - [Tint experimental extensions](docs/tint/experimental_extensions.md)
Jaswant Panchumarti14d1f6c2024-07-10 02:59:02 +0000[diff] [blame]50 - [Quickstart with CMake](docs/quickstart-cmake.md)
Corentin Wallez11986252024-08-30 18:42:12 +0000[diff] [blame]51 - [Becoming a committer](docs/becoming-committer.md)
dan sinclair5ee22f32022-04-28 16:25:43 +0000[diff] [blame]52
David Netob5bced22018-11-13 09:10:37 +0000[diff] [blame]53
Corentin Walleze3faaae2020-10-21 14:37:52 +0000[diff] [blame]54User documentation: (TODO, figure out what overlaps with the webgpu.h docs)
David Netob5bced22018-11-13 09:10:37 +0000[diff] [blame]55
Corentin Wallez3b246682018-08-16 13:50:49 +0200[diff] [blame]56## License
57
Austin Engcc2516a2023-10-17 20:57:54 +0000[diff] [blame]58BSD 3-Clause License, please see [LICENSE](/LICENSE).
Corentin Wallez3b246682018-08-16 13:50:49 +0200[diff] [blame]59
60## Disclaimer
61
62This is not an officially supported Google product.