encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
dawn-cmake/README.md

55 lines
2.5 KiB
Markdown
Raw Normal View History

Shuffle 'docs' directories As part of the tint -> dawn merge. Bug: dawn:1275 Change-Id: Ice0c9d2f03f6d7e96471cf8398aecd16273c833f Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/78400 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Ben Clayton <bclayton@google.com>
2022-01-27 18:33:47 +00:00
![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")
Add Dawn's logo and use it in README.md Change-Id: Ia504f2025c8a7ea139b41d72140a36510ad7db0b Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/63380 Reviewed-by: François Beaufort <beaufort.francois@gmail.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2021-09-02 09:51:40 +00:00
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
# Dawn, a WebGPU implementation
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
Dawn is an open-source and cross-platform implementation of the work-in-progress [WebGPU](https://webgpu.dev) standard.
Fix inclusive language presubmit The current presubmit has the filter inverted so it would only attempt to match the filtered files. The file name also has to be converted to `LocalPath` otherwise it's attempting to compare a python object to a string and always fails to match. Bug: dawn:1339 Change-Id: Ie7712dee60f6b9df2cb78c9feab11769f7ea1f02 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/87080 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Dan Sinclair <dsinclair@chromium.org> Auto-Submit: Dan Sinclair <dsinclair@chromium.org>
2022-04-19 22:25:45 +00:00
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.
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
Dawn is meant to be integrated as part of a larger system and is the underlying implementation of WebGPU in Chromium.
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
Dawn provides several WebGPU building blocks:
- **WebGPU C/C++ headers** that applications and other building blocks use.
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
- The `webgpu.h` version that Dawn implements.
- A C++ wrapper for the `webgpu.h`.
Fix addition of README.md's content to README.chromium Bug: dawn:1397 Change-Id: Ie6de5462b319a5991362b4eeac6b1baa2e6e38f1 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/98640 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Dan Sinclair <dsinclair@chromium.org> Auto-Submit: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Dan Sinclair <dsinclair@chromium.org>
2022-08-09 14:09:00 +00:00
- **A "native" implementation of WebGPU** using platforms' GPU APIs: D3D12, Metal, Vulkan and OpenGL. See [per API support](docs/support.md) for more details.
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
- **A client-server implementation of WebGPU** for applications that are in a sandbox without access to native drivers
Fix addition of README.md's content to README.chromium Bug: dawn:1397 Change-Id: Ie6de5462b319a5991362b4eeac6b1baa2e6e38f1 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/98640 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Dan Sinclair <dsinclair@chromium.org> Auto-Submit: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Dan Sinclair <dsinclair@chromium.org>
2022-08-09 14:09:00 +00:00
- **Tint** is a compiler for the WebGPU Shader Language (WGSL) that can be used in standalone to convert shaders from and to WGSL.
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
Helpful links:
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
Cleanup duplicate files; Combine README and build docs. This PR cleans up some of the documentation post Dawn+Tint merge. The README is better combined, the building document is moved up a level as it covers both Tint and Dawn. The various duplicate files are removed. Bug: dawn:1339 Change-Id: I829fbc32529a304fbc55eac3fda86d52c1a6952e Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/88340 Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org> Auto-Submit: Dan Sinclair <dsinclair@chromium.org>
2022-04-28 16:25:43 +00:00
- [Dawn bug tracker](https://bugs.chromium.org/p/dawn/issues/entry) if you find issues with Dawn.
- [Tint bug tracker](https://bugs.chromium.org/p/tint/issues/entry) if you find issues with Tint.
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
- [Dawn's mailing list](https://groups.google.com/forum/#!members/dawn-graphics) for other discussions related to Dawn.
- [Dawn's source code](https://dawn.googlesource.com/dawn)
Fix typo in README.md Bug: None TBR=enga@chromium.org Change-Id: Ib86da5fca2fb3cf1287cca47be1d739433fd2048 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/28420 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2020-09-11 10:38:46 +00:00
- [Dawn's Matrix chatroom](https://matrix.to/#/#webgpu-dawn:matrix.org) for live discussion around contributing or using Dawn.
Add Matrix chatrooms to README.md Bug: None Change-Id: I72f7df3326cc91d7306db13145cdae9e50982bf2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/20380 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2020-04-24 12:38:13 +00:00
- [WebGPU's Matrix chatroom](https://matrix.to/#/#WebGPU:matrix.org)
Cleanup duplicate files; Combine README and build docs. This PR cleans up some of the documentation post Dawn+Tint merge. The README is better combined, the building document is moved up a level as it covers both Tint and Dawn. The various duplicate files are removed. Bug: dawn:1339 Change-Id: I829fbc32529a304fbc55eac3fda86d52c1a6952e Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/88340 Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org> Auto-Submit: Dan Sinclair <dsinclair@chromium.org>
2022-04-28 16:25:43 +00:00
- [Tint mirror](https://dawn.googlesource.com/tint) for standalone usage.
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
## Documentation table of content
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
Developer documentation:
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
Shuffle 'docs' directories As part of the tint -> dawn merge. Bug: dawn:1275 Change-Id: Ice0c9d2f03f6d7e96471cf8398aecd16273c833f Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/78400 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Ben Clayton <bclayton@google.com>
2022-01-27 18:33:47 +00:00
- [Dawn overview](docs/dawn/overview.md)
Cleanup duplicate files; Combine README and build docs. This PR cleans up some of the documentation post Dawn+Tint merge. The README is better combined, the building document is moved up a level as it covers both Tint and Dawn. The various duplicate files are removed. Bug: dawn:1339 Change-Id: I829fbc32529a304fbc55eac3fda86d52c1a6952e Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/88340 Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org> Auto-Submit: Dan Sinclair <dsinclair@chromium.org>
2022-04-28 16:25:43 +00:00
- [Building](docs/building.md)
- [Contributing](CONTRIBUTING.md)
- [Code of Conduct](CODE_OF_CONDUCT.md)
Shuffle 'docs' directories As part of the tint -> dawn merge. Bug: dawn:1275 Change-Id: Ice0c9d2f03f6d7e96471cf8398aecd16273c833f Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/78400 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Ben Clayton <bclayton@google.com>
2022-01-27 18:33:47 +00:00
- [Testing Dawn](docs/dawn/testing.md)
- [Debugging Dawn](docs/dawn/debugging.md)
- [Dawn's infrastructure](docs/dawn/infra.md)
- [Dawn errors](docs/dawn/errors.md)
Cleanup duplicate files; Combine README and build docs. This PR cleans up some of the documentation post Dawn+Tint merge. The README is better combined, the building document is moved up a level as it covers both Tint and Dawn. The various duplicate files are removed. Bug: dawn:1339 Change-Id: I829fbc32529a304fbc55eac3fda86d52c1a6952e Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/88340 Kokoro: Kokoro <noreply+kokoro@google.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org> Auto-Submit: Dan Sinclair <dsinclair@chromium.org>
2022-04-28 16:25:43 +00:00
- [Tint experimental extensions](docs/tint/experimental_extensions.md)
README.md: Need pkg-config on Linux Change-Id: I32a2f8e2668514b6fc80163f1c567a4038c12d1c Reviewed-on: https://dawn-review.googlesource.com/c/2340 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2018-11-13 09:10:37 +00:00
Trivial grammar fix in README.md This is mostly a CL to see if the CQ is able to land commits after the renaming of Dawn's primary branch to "main". Bug: dawn:555 Change-Id: I8bf176be2320521de72adb2d91893fb350a379b1 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/30702 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org> Reviewed-by: dan sinclair <dsinclair@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org> Commit-Queue: dan sinclair <dsinclair@chromium.org>
2020-10-21 14:37:52 +00:00
User documentation: (TODO, figure out what overlaps with the webgpu.h docs)
README.md: Need pkg-config on Linux Change-Id: I32a2f8e2668514b6fc80163f1c567a4038c12d1c Reviewed-on: https://dawn-review.googlesource.com/c/2340 Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2018-11-13 09:10:37 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
## Status
Initial commit of all the NXT integration. More like squashed history, contributors were: - Kai Ninomiya - Corentin Wallez
2017-04-20 18:38:20 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
(TODO)
Remove references to Github in README and CONTRIBUTING BUG=dawn:23 Change-Id: I538271d67581da4212e62662617890bd28f624df Reviewed-on: https://dawn-review.googlesource.com/c/1780 Reviewed-by: David Neto <dneto@google.com> Reviewed-by: Corentin Wallez <cwallez@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2018-10-08 13:51:18 +00:00
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
## License
Initial commit of all the NXT integration. More like squashed history, contributors were: - Kai Ninomiya - Corentin Wallez
2017-04-20 18:38:20 +00:00
docs: write an overview of Dawn and split README.md BUG=dawn:23 Change-Id: Ib071a4bcccee267ea0ff8af3ddb858e6c54a7eb2 Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/14160 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2019-12-05 11:01:41 +00:00
Apache 2.0 Public License, please see [LICENSE](/LICENSE).
Initial commit of all the NXT integration. More like squashed history, contributors were: - Kai Ninomiya - Corentin Wallez
2017-04-20 18:38:20 +00:00
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
## Disclaimer
Initial commit of all the NXT integration. More like squashed history, contributors were: - Kai Ninomiya - Corentin Wallez
2017-04-20 18:38:20 +00:00
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
This is not an officially supported Google product.