ANGLE-like library for Chromium's next-generation Web graphics API prototype.
Switch branches/tags
Nothing to show
Clone or download
Kangz PRESUBMIT.py: Add formatting checks.
GN files are checked using the canned presubmit check but we cannot do
the same for C/C++ files: the canned check uses git cl format which can
only use clang-format 5.0 and requires formatting of all the source
code.

Instead we write our own clang-format check, reusing the script that
checks formatting on Travis. To have a recent version of clang-format we
import one from a helper repo.

This also fix a formatting error in .gn and adds licenses to the
clang-format linting scripts.

Change-Id: I4d8208472a8a6bd32ae3ef41c3145abf270a4c37
Latest commit 4c35101 Aug 27, 2018
Permalink
Failed to load latest commit information.
build_overrides GN: Use hermetic builds on Linux Sep 5, 2018
examples Descriptorize ComputePipeline Sep 5, 2018
generator Make Dawn error macro more explicit and have an "error type" Sep 11, 2018
infra/config infra: Add a presubmit builder to the CQ. Sep 6, 2018
scripts PRESUBMIT.py: Add formatting checks. Sep 11, 2018
src Make Dawn error macro more explicit and have an "error type" Sep 11, 2018
third_party Validate SPIR-V code when creating ShaderModules Sep 7, 2018
.appveyor.yml Rename CMakeLists targets nxt -> dawn Jul 18, 2018
.clang-format Add .clang-format Nov 28, 2017
.gitignore Add initial BUILD.gn files for libdawn[|_native|_wire] Aug 6, 2018
.gitmodules Roll SPIRV-Cross and use upstream repo. Aug 24, 2018
.gn PRESUBMIT.py: Add formatting checks. Sep 11, 2018
.travis.yml Update Travis to use clang-format-8 after LLVm release Aug 27, 2018
AUTHORS Rename NXT -> Dawn in the comments Jul 18, 2018
BUILD.gn Validate SPIR-V code when creating ShaderModules Sep 7, 2018
CMakeLists.txt Update which backends are enabled by default Aug 2, 2018
CONTRIBUTING.md Initial commit of all the NXT integration. Apr 20, 2017
DEPS PRESUBMIT.py: Add formatting checks. Sep 11, 2018
LICENSE Initial commit of all the NXT integration. Apr 20, 2017
OWNERS Add OWNERS and README.chromium Aug 17, 2018
PRESUBMIT.py PRESUBMIT.py: Add formatting checks. Sep 11, 2018
README.chromium Add OWNERS and README.chromium Aug 17, 2018
README.md Fix list nesting in README.md Aug 20, 2018
codereview.settings Initial CQ configuration Aug 23, 2018
dawn.json Descriptorize ComputePipeline Sep 5, 2018

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.