CMake-only fork of https://dawn.googlesource.com/dawn with cleaned, vendored dependencies
Go to file
Ben Clayton 7b366475ed [utils]: Add EnumSet
Simple container for sets of enum values.

Change-Id: I9efe5fc15e9f179cb63b64f3783235a92013a2b3
Reviewed-on: https://dawn-review.googlesource.com/c/tint/+/53083
Commit-Queue: Ben Clayton <bclayton@google.com>
Reviewed-by: David Neto <dneto@google.com>
Kokoro: Kokoro <noreply+kokoro@google.com>
2021-06-03 15:53:34 +00:00
.vscode .vscode/tasks.json: Make build & configure work for windows. 2021-03-30 20:10:08 +00:00
build_overrides Remove obsolete GN config 2021-01-18 15:25:23 +00:00
docs docs: Add a guide for writing diagnostic messages 2021-06-02 20:50:24 +00:00
fuzzers Remove fuzzing for transform::EmitVertPointSize 2021-05-07 15:48:04 +00:00
include/tint Remove legacy EmitVertexPointSize transform 2021-05-11 13:16:10 +00:00
infra/config Migrate Linux CQ from Xenial to Bionic 2021-05-24 08:32:55 +00:00
kokoro Kokoro: Check lint and doxygen 2021-05-12 08:15:41 +00:00
samples main: Replace --dawn-validation with --validate 2021-06-02 21:02:34 +00:00
src [utils]: Add EnumSet 2021-06-03 15:53:34 +00:00
test [utils]: Add EnumSet 2021-06-03 15:53:34 +00:00
third_party Fix VS clang-cl build 2021-03-09 21:51:50 +00:00
tools Fix fileutils not working on Windows 2021-06-03 15:08:44 +00:00
.clang-format Initial commit 2020-03-02 15:47:43 -05:00
.gitignore gitignore /build*/ folders 2021-05-18 14:42:47 +00:00
.gn Get `gn gen --check` actually working in repo 2021-04-21 19:05:14 +00:00
AUTHORS Add AUTHORS file 2021-03-17 17:54:33 +00:00
BUILD.gn BUILD.gn: Remove the temporary group with Dawn migrated. 2021-03-17 07:41:03 +00:00
CMakeLists.txt Kokoro: Check lint and doxygen 2021-05-12 08:15:41 +00:00
CMakeSettings.json Add CMakeSettings.json with convenient defaults 2021-03-16 18:52:53 +00:00
CODE_OF_CONDUCT.md Initial commit 2020-03-02 15:47:43 -05:00
CONTRIBUTING.md Add a style guide 2021-04-08 15:10:47 +00:00
CPPLINT.cfg Adding PRESUBMIT.py with a bunch of checks turned on 2020-06-03 13:41:41 +00:00
DEPS Update SPIRV-Tools, SPIRV-Headers 2021-05-13 14:03:12 +00:00
Doxyfile Kokoro: Check lint and doxygen 2021-05-12 08:15:41 +00:00
LICENSE Initial commit 2020-03-02 15:47:43 -05:00
OWNERS Add an OWNERS file 2021-03-08 16:07:55 +00:00
PRESUBMIT.py Add language check 2020-11-16 15:01:27 +00:00
README.md Proposed process for experimental extensions 2021-04-27 17:55:07 +00:00
standalone.gclient Convert dependency management to using gclient 2020-03-05 15:58:27 +00:00
tint_overrides_with_defaults.gni Change the default for BUILD.gn to build all the modules 2020-07-30 18:44:04 +00:00

README.md

Tint

Tint is a compiler for the WebGPU Shader Language (WGSL).

This is not an officially supported Google product.

Requirements

  • Git
  • CMake (3.10.2 or later)
  • Ninja (or other build tool)
  • Python, for fetching dependencies
  • depot_tools in your path

Build options

  • TINT_BUILD_SPV_READER : enable the SPIR-V input reader (off by default)
  • TINT_BUILD_WGSL_READER : enable the WGSL input reader (on by default)
  • TINT_BUILD_SPV_WRITER : enable the SPIR-V output writer (on by default)
  • TINT_BUILD_WGSL_WRITER : enable the WGSL output writer (on by default)
  • TINT_BUILD_FUZZERS : enable building fuzzzers (off by default)

Building

Tint uses Chromium dependency management so you need to install depot_tools and add it to your PATH.

Getting source & dependencies

# Clone the repo as "tint"
git clone https://dawn.googlesource.com/tint tint
cd tint

# Bootstrap the gclient configuration
cp standalone.gclient .gclient

# Fetch external dependencies and toolchains with gclient
gclient sync

Compiling using CMake + Ninja

mkdir -p out/Debug
cd out/Debug
cmake -GNinja ../..
ninja # or autoninja

Compiling using CMake + make

mkdir -p out/Debug
cd out/Debug
cmake ../..
make # -j N for N-way parallel build

Compiling using gn + ninja

mkdir -p out/Debug
gn gen out/Debug
autoninja -C out/Debug

Fuzzers on MacOS

If you are attempting fuzz, using TINT_BUILD_FUZZERS=ON, the version of llvm in the XCode SDK does not have the needed libfuzzer functionality included.

The build error that you will see from using the XCode SDK will look something like this:

ld: file not found:/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/clang/11.0.0/lib/darwin/libclang_rt.fuzzer_osx.a

The solution to this problem is to use a full version llvm, like what you would get via homebrew, brew install llvm, and use something like CC=<path to full clang> cmake .. to setup a build using that toolchain.

Checking [chromium-style] issues in CMake builds

The gn based work flow uses the Chromium toolchain for building in anticipation of integration of Tint into Chromium based projects. This toolchain has additional plugins for checking for style issues, which are marked with [chromium-style] in log messages. This means that this toolchain is more strict then the default clang toolchain.

In the future we will have a CQ that will build this work flow and flag issues automatically. Until that is in place, to avoid causing breakages you can run the [chromium-style] checks using the CMake based work flows. This requires setting CC to the version of clang checked out by gclient sync and setting the TINT_CHECK_CHROMIUM_STYLE to ON.

mkdir -p out/style
cd out/style
cmake ../..
CC=../../third_party/llvm-build/Release+Asserts/bin/clang cmake -DTINT_CHECK_CHROMIUM_STYLE=ON ../../ # add -GNinja for ninja builds

Issues

Please file any issues or feature requests at https://bugs.chromium.org/p/tint/issues/entry

Contributing

Please see the CONTRIBUTING and CODE_OF_CONDUCT files on how to contribute to Tint.

Tint has a process for supporting experimental extensions.