commit | e2fc824aa26320dd5a0022fda285f396f61a3f49 | [log] [tgz] |
---|---|---|
author | David Neto <dneto@google.com> | Wed Jun 14 11:12:12 2017 -0400 |
committer | David Neto <dneto@google.com> | Wed Jun 14 11:12:57 2017 -0400 |
tree | c1bf3c49953efa189ccc7bf7fb222c46281a6ddf | |
parent | 985ff1f8871553f64fae6d8748995d0d0918ccbe [diff] | |
parent | aede4fe9571a1be4e8962c3149772bb9fcc604f1 [diff] |
Merge remote-tracking branch 'aosp/upstream-master' into update-shaderc aede4fe Fix Glslang test dir path for MSVC build 760c3f5 React to new SPIRV-Tools source files 0dd731a React to removed Glslang .cpp files 1adfc98 Update tests for Glslang global warning changes 6ff1564 Add layout(location = 0) where needed in tests. b1228ba Adjust copying of Glslang test files, for include test 558dede Shorten arg checking for -f*-binding-base 7df8217 Reject negative numbers when parsing unsigned. 63313f9 Add -fuav-binding-base cdcc015 Support setting SSBO binding base 357d24b Add glslc options to set binding base for uniforms 735a541 Add shaderc_compile_options_set_binding_base_for_stage c1729a4 Add libshaderc_util::Compiler::SetAutoBindingBaseForStage 2c7db7c Add shaderc_util::Compiler::Stage da4f9b0 Add generic names for shader stages a290067 Add glslc options to set binding base numbers d8eb937 Add C, C++ API to set binding base for uniforms b54a418 Add libshaderc_util::SetAutoBindingBase b7b4892 Add -flimit-file to glslc doc summary a532710 Document some recent changes, e.g. HLSL offsets 7261ab8 Fix Travis-CI so ctest emits output on failure 3c85d26 Make git ignore android_test/libs 580d540 Support SPIR-V 1.2 in SPIRV-Tools Android build dcb3036 Avoid mem leaks in counting includer test 44823cb Add util/bit_stream.cpp in Android.mk for SPIRV-Tools a571eef Trim Appveyor notification list 659b796 Fix test to update glslang 9b3dbd1 Avoid noexcept-type in GCC 7.1 for test code 21e2016 Added compact_ids_pass.cpp to Android.mk 380e143 React to Glslang #version error message for HLSL ed5e93e Update tests for different Glslang error message 3966711 SPIRV-Tools added flatten decorations pass Test: checkbuild.py on Linux; unit tests on Windows Change-Id: Ib1eea190aad44d87fe459966bda269925b3040d6
A collection of tools, libraries and tests for shader compilation. At the moment it includes:
glslc
, a command line compiler for GLSL/HLSL to SPIR-V, andlibshaderc
, a library API for doing the same.Shaderc wraps around core functionality in glslang and SPIRV-Tools. Shaderc aims to to provide:
#include
supportShaderc has maintained backward compatibility for quite some time, and we don't anticipate any breaking changes. Ongoing enhancements are described in the CHANGES file.
Shaderc has been shipping in the Android NDK since version r12b. (The NDK build uses sources from https://android.googlesource.com/platform/external/shaderc/. Those repos are downstream from GitHub.)
For licensing terms, please see the LICENSE
file. If interested in contributing to this project, please see CONTRIBUTING.md
.
This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google. That may change if Shaderc gains contributions from others. See the CONTRIBUTING.md
file for more information. See also the AUTHORS
and CONTRIBUTORS
files.
android_test/
: a small Android application to verify compilationcmake/
: CMake utility functions and configuration for Shadercexamples/
: Example programsglslc/
: an executable to compile GLSL to SPIR-Vlibshaderc/
: a library for compiling shader strings into SPIR-Vlibshaderc_util/
: a utility library used by multiple shaderc componentsthird_party/
: third party open source packages; see belowutils/
: utility scripts for ShadercShaderc depends on glslang, the Khronos reference compiler for GLSL. Sometimes a change updates both Shaderc and glslang. In that case the glslang change will appear in google/glslang before it appears upstream in KhronosGroup/glslang We intend to upstream all changes to glslang. We maintain the separate copy only to stage those changes for review, and to provide something for Shaderc to build against in the meantime. Please see DEVELOPMENT.howto.md for more details.
Shaderc depends on SPIRV-Tools for assembling, disassembling, and transforming SPIR-V binaries.
Shaderc depends on the Google Test testing framework.
In the following sections, $SOURCE_DIR
is the directory you intend to clone Shaderc into.
git clone https://github.com/google/shaderc $SOURCE_DIR cd $SOURCE_DIR/third_party git clone https://github.com/google/googletest.git git clone https://github.com/google/glslang.git git clone https://github.com/KhronosGroup/SPIRV-Tools.git spirv-tools git clone https://github.com/KhronosGroup/SPIRV-Headers.git spirv-tools/external/spirv-headers cd $SOURCE_DIR/
Note: The known-good branch of the repository contains a known_good.json file describing a set of repo URLs and specific commits that have been tested together. This information is updated periodically, and typically matches the latest update of these sources in the development branch of the Android NDK. The known-good
branch also contains a update_shaderc.py script that will read the JSON file and checkout those specific commits for you.
Ensure you have the requisite tools -- see the tools subsection below.
Decide where to place the build output. In the following steps, we'll call it $BUILD_DIR
. Any new directory should work. We recommend building outside the source tree, but it is also common to build in a (new) subdirectory of $SOURCE_DIR
, such as $SOURCE_DIR/build
.
4a) Build (and test) with Ninja on Linux or Windows:
cd $BUILD_DIR cmake -GNinja -DCMAKE_BUILD_TYPE={Debug|Release|RelWithDebInfo} $SOURCE_DIR ninja ctest # optional
4b) Or build (and test) with MSVC on Windows:
cd $BUILD_DIR cmake $SOURCE_DIR cmake --build . --config {Release|Debug|MinSizeRel|RelWithDebInfo} ctest -C {Release|Debug|MinSizeRel|RelWithDebInfo}
4c) Or build with MinGW on Linux for Windows: (Skip building threaded unit tests due to Googletest bug 606)
cd $BUILD_DIR cmake -GNinja -DCMAKE_BUILD_TYPE={Debug|Release|RelWithDebInfo} $SOURCE_DIR \ -DCMAKE_TOOLCHAIN_FILE=$SOURCE_DIR/cmake/linux-mingw-toolchain.cmake \ -Dgtest_disable_pthreads=ON ninja
After a successful build, you should have a glslc
executable somewhere under the $BUILD_DIR/glslc/
directory, as well as a libshaderc
library somewhere under the $BUILD_DIR/libshaderc/
directory.
The default behavior on MSVC is to link with the static CRT. If you would like to change this behavior -DSHADERC_ENABLE_SHARED_CRT
may be passed on the cmake configure line.
See the libshaderc README for more on using the library API in your project.
For building, testing, and profiling Shaderc, the following tools should be installed regardless of your OS:
On Linux, the following tools should be installed:
gcov
: for testing code coverage, provided by the gcc
package on Ubuntu.lcov
: a graphical frontend for gcov
, provided by the lcov
package on Ubuntu.genhtml
: for creating reports in html format from lcov
output, provided by the lcov
package on Ubuntu.On Linux, if cross compiling to Windows:
mingw
: A GCC-based cross compiler targeting Windows so that generated executables use the Micrsoft C runtime libraries.On Windows, the following tools should be installed and available on your path:
diff
.Optionally, the following tools may be installed on any OS:
asciidoctor
: for generating documenation.pygments.rb
required by asciidoctor
for syntax highlighting.nosetests
: for testing the Python code.Please make sure you have the Docker engine installed on your machine.
To create a Docker image containing Shaderc command line tools, issue the following command in ${SOURCE_DIR}
: docker build -t <IMAGE-NAME> .
. The created image will have all the command line tools installed at /usr/local
interally, and a data volume mounted at /code
.
Assume <IMAGE-NAME>
is shaderc/shaderc
from now on.
To invoke a tool from the above created image in a Docker container:
docker run shaderc/shaderc glslc --version
Alternatively, you can mount a host directory (e.g., example
) containing the shaders you want to manipulate and run different kinds of tools via an interactive shell in the container:
$ docker run -i -t -v `pwd`/example:/code shaderc/shaderc /code $ ls test.vert /code $ glslc -c -o - test.vert | spirv-dis
We track bugs using GitHub -- click on the “Issues” button on the project's GitHub page.
On Linux, you can obtain test coverage as follows:
cd $BUILD_DIR cmake -GNinja -DCMAKE_BUILD_TYPE=Debug -DENABLE_CODE_COVERAGE=ON $SOURCE_DIR ninja ninja report-coverage
Then the coverage report can be found under the $BUILD_DIR/coverage-report
directory.
Bindings are maintained by third parties, may contain content offered under a different license, and may reference or contain older versions of Shaderc and its dependencies.