encounter
/
dawn-cmake
mirror of https://github.com/encounter/dawn-cmake.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
706 Commits 2 Branches 0 Tags 145 MiB
C++ 59.9%
HLSL 18.2%
GLSL 17.3%
Go 2.1%
Objective-C++ 0.8%
Other 1.6%
Go to file
Corentin Wallez 58017e91ad Use Chromium's dcheck_always_on when available. 
This will make GPU tests running on Chromium-based builders respect this
configuration, which is important to have the same code run in Release
and Debug builds on the GPU FYI waterfall.

BUG=chromium:901830

Change-Id: Ia2f6f3585c4b6213fe7f55203c69d0ef4a620a67
Reviewed-on: https://dawn-review.googlesource.com/c/2708
Reviewed-by: Stephen White <senorblanco@chromium.org>
Reviewed-by: Kenneth Russell <kbr@google.com>
Commit-Queue: Corentin Wallez <cwallez@chromium.org>
 		2018-11-30 12:17:29 +00:00
build_overrides Roll shaderc and glslang and use their BUILD.gn 2018-10-04 17:17:57 +00:00
examples Change Copy Operation Interfaces to Match WebGPU IDL 2018-11-28 17:54:13 +00:00
generator WireCmd: require opt-in to treat ID 0 as nullptr instead of error. 2018-11-28 17:00:33 +00:00
infra/config Run mac-dawn-rel on the CQ 2018-11-27 15:40:30 +00:00
scripts Roll shaderc and glslang and use their BUILD.gn 2018-10-04 17:17:57 +00:00
src Result: Add default template for Result<T, E> 2018-11-29 12:40:26 +00:00
third_party Roll GLFW to pick up macOS Mojave fixes 2018-11-19 10:21:23 +00:00
.clang-format Add .clang-format 2017-11-28 16:18:39 -05:00
.gitignore Remove support for CMake builds 2018-10-31 10:53:11 +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 Use Chromium's dcheck_always_on when available. 2018-11-30 12:17:29 +00:00
CONTRIBUTING.md Remove references to Github in README and CONTRIBUTING 2018-10-08 13:51:18 +00:00
DEPS Roll SPIRV-Tools and temporarily use Vulkan SPIRV validation 2018-11-28 16:54:31 +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: Need pkg-config on Linux 2018-11-13 09:10:37 +00:00
codereview.settings Initial CQ configuration 2018-08-23 08:33:35 -04:00
dawn.json Change Copy Operation Interfaces to Match WebGPU IDL 2018-11-28 17:54:13 +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.

License

Please see LICENSE.

Disclaimer

This is not an officially supported Google product.