commit | 519b16c4b026e177a94bfa10f02bce66742f599e | [log] [tgz] |
---|---|---|
author | Austin Eng <enga@chromium.org> | Tue Sep 17 21:02:38 2019 +0000 |
committer | Commit Bot service account <commit-bot@chromium.org> | Tue Sep 17 21:02:38 2019 +0000 |
tree | d642c62437cd8db07858b538f16f68df2e09a6eb | |
parent | 7f3f331ce69c8daac99f7882206196b7cec7280d [diff] |
Add README.md for the Dawn perf test harness Bug: dawn:208 Change-Id: Ic9b4c83ab3c27851d149adb5986f3a5556d0548a Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/11283 Commit-Queue: Austin Eng <enga@chromium.org> Reviewed-by: Kai Ninomiya <kainino@chromium.org>
Dawn (formerly NXT) is an open-source and cross-platform implementation of the work-in-progress WebGPU standard. It exposes a C/C++ API that maps almost one-to-one to the WebGPU IDL and can be managed as part of a larger system such as a Web browser.
Dawn provides several WebGPU building blocks:
dawn.json
: description of the API used to drive code generators.examples
: examples showing how Dawn is used.generator
: code generator for files produces from dawn.json
templates
: Jinja2 templates for the generatorscripts
: scripts to support things like continuous testing, build files, etc.src
:common
: helper code shared between core Dawn libraries and tests/samplesdawn_native
: native implementation of WebGPU, one subfolder per backenddawn_wire
: client-server implementation of WebGPUinclude
: public headers for Dawntests
: internal Dawn testsend2end
: WebGPU tests performing GPU operationsunittests
: unittests and by extension tests not using the GPUvalidation
: WebGPU validation tests not using the GPU (frontend tests)utils
: helper code to use Dawn used by tests and samplesthird_party
: directory where dependencies live as well as their buildfiles.Dawn uses the Chromium build system and dependency management so you need to install depot_tools and add it to the PATH.
On Linux you need to have the pkg-config
command:
# Install pkg-config on Ubuntu sudo apt-get install pkg-config
Then get the source as follows:
# Clone the repo as "dawn" git clone https://dawn.googlesource.com/dawn dawn && cd dawn # Bootstrap the gclient configuration cp scripts/standalone.gclient .gclient # Fetch external dependencies and toolchains with gclient gclient sync
Then generate build files using gn args out/Debug
or gn args out/Release
. A text editor will appear asking build options, the most common option is is_debug=true/false
; otherwise gn args out/Release --list
shows all the possible options.
Then use ninja -C out/Release
to build dawn and for example ./out/Release/dawn_end2end_tests
to run the tests.
Please read and follow CONTRIBUTING.md. Dawn doesn‘t have a formal coding style yet, except what’s defined by our clang format style. Overall try to use the same style and convention as code around your change.
If you find issues with Dawn, please feel free to report them on the bug tracker. For other discussions, please post to Dawn's mailing list.
Please see LICENSE.
This is not an officially supported Google product.