CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
Go to file
Corentin Wallez 038a8554ad Add component to OWNERS and fixup repo URL in README.chromium
BUG=chromium:870747

Change-Id: I678393ca29f934ecc23f0140d2d211fccf619a5f
Reviewed-on: https://dawn-review.googlesource.com/1640
Reviewed-by: Stephen White <senorblanco@chromium.org>
Reviewed-by: Kai Ninomiya <kainino@chromium.org>
2018-09-25 20:53:37 +00:00
build_overrides GN: Use hermetic builds on Linux 2018-09-05 05:18:10 -04:00
examples Introduce [Render|Compute]PassEncoder. 2018-09-21 00:24:37 +00:00
generator Fix a typo in main.py 2018-09-21 06:55:25 +00:00
infra/config luci-milo.cfg: Add logo 2018-09-22 00:45:58 +00:00
scripts PRESUBMIT.py: Add formatting checks. 2018-09-11 08:06:36 -04:00
src Wire: Add support for nullptr objects as arguments 2018-09-21 00:28:33 +00:00
third_party Validate SPIR-V code when creating ShaderModules 2018-09-07 05:41:25 -04:00
.appveyor.yml Rename CMakeLists targets nxt -> dawn 2018-07-18 22:54:06 +02:00
.clang-format Add .clang-format 2017-11-28 16:18:39 -05:00
.gitignore Add initial BUILD.gn files for libdawn[|_native|_wire] 2018-08-06 16:38:33 +02:00
.gitmodules Roll SPIRV-Cross and use upstream repo. 2018-08-24 12:28:28 -04:00
.gn PRESUBMIT.py: Add formatting checks. 2018-09-11 08:06:36 -04:00
.travis.yml Update Travis to use clang-format-8 after LLVm release 2018-08-27 05:32:07 -04:00
AUTHORS Rename NXT -> Dawn in the comments 2018-07-18 22:54:06 +02:00
BUILD.gn Introduce [Render|Compute]PassEncoder. 2018-09-21 00:24:37 +00:00
CMakeLists.txt Update which backends are enabled by default 2018-08-02 13:39:07 +02:00
CONTRIBUTING.md Initial commit of all the NXT integration. 2017-04-20 14:38:20 -04:00
DEPS PRESUBMIT.py: Add formatting checks. 2018-09-11 08:06:36 -04:00
LICENSE Initial commit of all the NXT integration. 2017-04-20 14:38:20 -04:00
OWNERS Add component to OWNERS and fixup repo URL in README.chromium 2018-09-25 20:53:37 +00:00
PRESUBMIT.py PRESUBMIT.py: Add formatting checks. 2018-09-11 08:06:36 -04:00
README.chromium Add component to OWNERS and fixup repo URL in README.chromium 2018-09-25 20:53:37 +00:00
README.md Fix list nesting in README.md 2018-08-20 11:11:15 -04:00
codereview.settings Initial CQ configuration 2018-08-23 08:33:35 -04:00
dawn.json Introduce [Render|Compute]PassEncoder. 2018-09-21 00:24:37 +00:00

README.md

Dawn, a WebGPU implementation

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:

  • WebGPU C/C++ headers that applications and other building blocks use.
  • A "native" implementation of WebGPU using platforms' GPU APIs:
    • D3D12 on Windows 10
    • Metal on OSX (and eventually iOS)
    • Vulkan on Windows, Linux (eventually ChromeOS and Android too)
    • OpenGL as best effort where available
  • A client-server implementation of WebGPU for applications that are in a sandbox without access to native drivers

Directory structure

  • 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 generator
  • scripts: scripts to support things like continuous testing, build files, etc.
  • src:
    • common: helper code shared between core Dawn libraries and tests/samples
    • dawn_native: native implementation of WebGPU, one subfolder per backend
    • dawn_wire: client-server implementation of WebGPU
    • include: public headers for Dawn
    • tests: internal Dawn tests
      • end2end: WebGPU tests performing GPU operations
      • unittests: unittests and by extension tests not using the GPU
        • validation: WebGPU validation tests not using the GPU (frontend tests)
    • utils: helper code to use Dawn used by tests and samples
  • third_party: directory where dependencies live as well as their buildfiles.

Building Dawn

Dawn uses the Chromium build system and dependency management so you need to [install depot_tools] and add it to the PATH. Then get the source as follows:

# Clone the repo as "dawn"
git clone https://github.com/google/nxt-standalone.git 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.

Contributing

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.

License

Please see LICENSE.

Disclaimer

This is not an officially supported Google product.