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

Fix more broken links in docs 

The first patch missed some broken links. Also, the directory structure
has changed.

Change-Id: I44631e371896b74d8a4dc9dc2c942dee32ce5340
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/134020
Kokoro: Kokoro <noreply+kokoro@google.com>
Commit-Queue: Albin Bernhardsson <albin.bernhardsson@arm.com>
Reviewed-by: Corentin Wallez <cwallez@chromium.org>
This commit is contained in:
Albin Bernhardsson 2023-05-22 15:16:39 +00:00 committed by Dawn LUCI CQ
parent 55e57b362b
commit dbaf032dc2
1 changed files with 25 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/dawn/overview.md
View File

@ -4,31 +4,32 @@ This repository contains the implementation of Dawn, which is itself composed of
## Directory structure ## Directory structure
- [`dawn.json`](../dawn.json): contains a description of the native WebGPU in JSON form. It is the data model that's used by the code generators. - [`dawn.json`](../../dawn.json): contains a description of the native WebGPU in JSON form. It is the data model that's used by the code generators.
- [`dawn_wire.json`](../dawn_wire.json): contains additional information used to generate `dawn_wire` files, such as commands in addition to regular WebGPU commands. - [`dawn_wire.json`](../../dawn_wire.json): contains additional information used to generate `dawn_wire` files, such as commands in addition to regular WebGPU commands.
- [`examples`](../examples): a small collection of samples using the native WebGPU API. They were mostly used when bringing up Dawn for the first time, and to test the `WGPUSwapChain` object. - [`generator`](../../generator): directory containg the code generators and their templates. Generators are based on Jinja2 and parse data-models from JSON files.
- [`generator`](../generator): directory containg the code generators and their templates. Generators are based on Jinja2 and parse data-models from JSON files. - [`dawn_json_generator.py`](../../generator/dawn_json_generator.py): the main code generator that outputs the WebGPU headers, C++ wrapper, client-server implementation, etc.
- [`dawn_json_generator.py`](../generator/dawn_json_generator.py): the main code generator that outputs the WebGPU headers, C++ wrapper, client-server implementation, etc. - [`templates`](../../generator/templates): Jinja2 templates for the generator, with subdirectories for groups of templates that are all used in the same library.
- [`templates`](../generator/templates): Jinja2 templates for the generator, with subdirectories for groups of templates that are all used in the same library. - [`include`](../../include):
- [`infra`](../infra): configuration file for the commit-queue infrastructure. - [`dawn`](../../include/dawn): public headers with subdirectories for each library. Note that some headers are auto-generated and not present directly in the directory.
- [`scripts`](../scripts): contains a grab-bag of files that are used for building Dawn, in testing, etc. - [`infra`](../../infra): configuration file for the commit-queue infrastructure.
- [`src`](../src): - [`scripts`](../../scripts): contains a grab-bag of files that are used for building Dawn, in testing, etc.
- [`dawn`](../src/dawn): root directory for Dawn code - [`src`](../../src):
- [`common`](../src/dawn/common): helper code that is allowed to be used by Dawn's core libraries, `dawn_native` and `dawn_wire`. Also allowed for use in all other Dawn targets. - [`dawn`](../../src/dawn): root directory for Dawn code
- [`fuzzers`](../src/dawn/fuzzers): various fuzzers for Dawn that are running in [Clusterfuzz](https://google.github.io/clusterfuzz/). - [`common`](../../src/dawn/common): helper code that is allowed to be used by Dawn's core libraries, `dawn_native` and `dawn_wire`. Also allowed for use in all other Dawn targets.
- [`native`](../src/dawn/native): code for the implementation of WebGPU on top of graphics APIs. Files in this folder are the "frontend" while subdirectories are "backends". - [`fuzzers`](../../src/dawn/fuzzers): various fuzzers for Dawn that are running in [Clusterfuzz](https://google.github.io/clusterfuzz/).
- [`native`](../../src/dawn/native): code for the implementation of WebGPU on top of graphics APIs. Files in this folder are the "frontend" while subdirectories are "backends".
- `<backend>`: code for the implementation of the backend on a specific graphics API, for example `d3d12`, `metal` or `vulkan`. - `<backend>`: code for the implementation of the backend on a specific graphics API, for example `d3d12`, `metal` or `vulkan`.
- [`tests`](../src/dawn/tests): - [`samples`](../../src/dawn/samples): a small collection of samples using the native WebGPU API. They were mostly used when bringing up Dawn for the first time, and to test the `WGPUSwapChain` object.
- [`end2end`](../src/dawn/tests/end2end): tests for the execution of the WebGPU API and require a GPU to run. - [`tests`](../../src/dawn/tests):
- [`perf_tests`](../src/dawn/tests/perf_tests): benchmarks for various aspects of Dawn. - [`end2end`](../../src/dawn/tests/end2end): tests for the execution of the WebGPU API and require a GPU to run.
- [`unittests`](../src/dawn/tests/unittests): code unittests of internal classes, but also by extension WebGPU API tests that don't require a GPU to run. - [`perf_tests`](../../src/dawn/tests/perf_tests): benchmarks for various aspects of Dawn.
- [`validation`](../src/dawn/tests/unittests/validation): WebGPU validation tests not using the GPU (frontend tests) - [`unittests`](../../src/dawn/tests/unittests): code unittests of internal classes, but also by extension WebGPU API tests that don't require a GPU to run.
- [`white_box`](../src/dawn/tests/white_box): tests using the GPU that need to access the internals of `dawn_native` or `dawn_wire`. - [`validation`](../../src/dawn/tests/unittests/validation): WebGPU validation tests not using the GPU (frontend tests)
- [`wire`](../src/dawn/wire): code for an implementation of WebGPU as a client-server architecture. - [`white_box`](../../src/dawn/tests/white_box): tests using the GPU that need to access the internals of `dawn_native` or `dawn_wire`.
- [`utils`](../src/dawn/utils): helper code to use Dawn used by tests and samples but disallowed for `dawn_native` and `dawn_wire`. - [`wire`](../../src/dawn/wire): code for an implementation of WebGPU as a client-server architecture.
- [`platform`](../src/dawn/platform): definition of interfaces for dependency injection in `dawn_native` or `dawn_wire`. - [`utils`](../../src/dawn/utils): helper code to use Dawn used by tests and samples but disallowed for `dawn_native` and `dawn_wire`.
- [`include`](../src/include): public headers with subdirectories for each library. Note that some headers are auto-generated and not present directly in the directory. - [`platform`](../../src/dawn/platform): definition of interfaces for dependency injection in `dawn_native` or `dawn_wire`.
- [`third_party`](../third_party): directory where dependencies live as well as their buildfiles. - [`third_party`](../../third_party): directory where dependencies live as well as their buildfiles.
## Dawn Native (`dawn_native`) ## Dawn Native (`dawn_native`)