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

53 lines
2.2 KiB
Markdown
Raw Normal View History

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
![Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo. The text "Dawn" is written below it.](docs/logo/dawn_logo.png "Dawn's logo")
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.
More precisely it implements [`webgpu.h`](https://github.com/webgpu-native/webgpu-headers/blob/master/webgpu.h) that is a one-to-one mapping with the WebGPU IDL.
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`.
Rewrite the README for Dawn.
2018-08-16 11:50:49 +00:00
- **A "native" implementation of WebGPU** using platforms' GPU APIs:
Fix list nesting in README.md Github Markdown needs at least two spaces of nesting to add a nesting level in lists.
2018-08-20 11:30:46 +00:00
- **D3D12** on Windows 10
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
- **Metal** on macOS and iOS
- **Vulkan** on Windows, Linux, ChromeOS, Android and Fuchsia
Fix list nesting in README.md Github Markdown needs at least two spaces of nesting to add a nesting level in lists.
2018-08-20 11:30:46 +00:00
- OpenGL as best effort where available
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
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
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 bug tracker](https://bugs.chromium.org/p/dawn/issues/entry) if you find issues with Dawn.
- [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)
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
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 overview](docs/overview.md)
docs: Mention to add `use_system_xcode=true` Also fix the name of the docs/building.md file. Bug: Change-Id: I342adcbc1427c533d2248d23d53f169d4a4a54cd Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/34466 Commit-Queue: Corentin Wallez <cwallez@chromium.org> Auto-Submit: Corentin Wallez <cwallez@chromium.org> Reviewed-by: Stephen White <senorblanco@chromium.org> Reviewed-by: Corentin Wallez <cwallez@chromium.org>
2020-12-02 15:59:49 +00:00
- [Building Dawn](docs/building.md)
Add docs/contributing.md Bug: dawn:23 Change-Id: I2cbf40c4079ea9d35c3d0c299c30e39b22eff80a Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/48420 Reviewed-by: Austin Eng <enga@chromium.org> Commit-Queue: Corentin Wallez <cwallez@chromium.org>
2021-04-21 18:05:01 +00:00
- [Contributing to Dawn](docs/contributing.md)
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
- [Testing Dawn](docs/testing.md)
- [Debugging Dawn](docs/debugging.md)
- [Dawn's infrastructure](docs/infra.md)
Improve validation errors, Part 1 Begin's using Abseil's string formatting and new error context tracking to dramatically improve the usefulness of validation messages. In addition to putting in place several utilities to enable better messages this change also updates the BindGroup buffers bindings validation messages as a test for the new mechanisms. Bug: dawn:563 Change-Id: Ie5bf5ffb24a9013cebd67745dc4172dfbc901e9a Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/64201 Commit-Queue: Brandon Jones <bajones@chromium.org> Reviewed-by: Austin Eng <enga@chromium.org>
2021-09-23 21:26:33 +00:00
- [Dawn errors](docs/errors.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.