CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
Go to file
Yunchao He 2a30e14074 Generate an error if scissor rect is empty
We need to change related tests in end2end_tests and unittests.

Bug=dawn:127
TEST=dawn_end2end_tests, dawn_unittests

Change-Id: I523d4eeb930990b5db381544b228d2f11912049b
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/6240
Commit-Queue: Yunchao He <yunchao.he@intel.com>
Reviewed-by: Kai Ninomiya <kainino@chromium.org>
Reviewed-by: Corentin Wallez <cwallez@chromium.org>
2019-04-02 07:42:18 +00:00
build_overrides Tell shaderc where to find SPIRV-Cross. 2018-12-14 20:33:50 +00:00
docs Implementation of Debug Marker APIs 2019-02-20 20:21:00 +00:00
examples Move vertex index format from RenderPipelineDesc to InputStateDesc 2019-03-28 17:09:23 +00:00
generator Nuke Builders part 4: headers, proctable and miscreferences 2019-04-01 21:48:38 +00:00
infra/config Add named cache for xcode installation. 2019-02-25 09:10:05 +00:00
scripts Split off common and libdawn / dawn_headers from BUILD.gn 2019-03-07 01:46:39 +00:00
src Generate an error if scissor rect is empty 2019-04-02 07:42:18 +00:00
third_party Remove GLVersion from GLAD header and make it static 2019-03-11 21:20:42 +00:00
.clang-format Add .clang-format 2017-11-28 16:18:39 -05:00
.gitignore Add wire_cmd.py and dawn_wire.json to autogenerate all wire commands. 2019-01-15 20:49:53 +00:00
.gn PRESUBMIT.py: Add formatting checks. 2018-09-11 08:06:36 -04:00
AUTHORS Rename NXT -> Dawn in the comments 2018-07-18 22:54:06 +02:00
BUILD.gn Nuke Builders Part 2: remove all builder code from wire 2019-04-01 21:04:17 +00:00
CONTRIBUTING.md Remove references to Github in README and CONTRIBUTING 2018-10-08 13:51:18 +00:00
DEPS Roll googletest to the same version as Chromium. 2019-02-21 09:26:20 +00: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 README.md: Add a link to the mailing list. 2018-12-12 16:14:53 +00:00
codereview.settings Initial CQ configuration 2018-08-23 08:33:35 -04:00
dawn.json Nuke Builders part 4: headers, proctable and miscreferences 2019-04-01 21:48:38 +00:00
dawn_wire.json Move CreateFence from Device to Queue 2019-03-06 22:42:22 +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.

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.

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.

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.

License

Please see LICENSE.

Disclaimer

This is not an officially supported Google product.