summaryrefslogtreecommitdiff
path: root/external/spirv-tools-generated/README.md
diff options
context:
space:
mode:
authorjsmall-nvidia <jsmall@nvidia.com>2020-07-31 16:31:30 -0400
committerGitHub <noreply@github.com>2020-07-31 13:31:30 -0700
commit4549597709e29b85b5f95503f4f2258c16db12be (patch)
treeef9dd57c9975e928950e0289e017bf622bea9298 /external/spirv-tools-generated/README.md
parentfc8b5758ca7a9b3aaf2f93d45ff570fab2a68bb8 (diff)
Upgrade to Glslang 11.0.0 (#1466)
* Fix premake5.lua so it uses the new path needed for OpenCLDebugInfo100.h * Keep including the includes directory. * Added the spirv-tools-generated files. * We don't need to include the spirv/unified1 path because the files needed are actually in the spirv-tools-generated folder. * Put the build_info.h glslang generated files in external/glslang-generated. Alter premake5.lua to pick up that header. * First pass at documenting how to build glslang and spirv-tools. * Improved glsl/spir-v tools README.md * Added revision.h * Change how gResources is calculated. Update about revision.h * Update docs a little. * Split out spirv-tools into a separate project for building glslang. This was not necessary on linux, but *is* necessary on windows, because there is a file disassemble.cpp in spirv-tools and in glslang, and this leads to VS choosing only one. With the separate library, the problem is resolved. * Fix direct-spirv-emit output. * Update to latest version of spirv headers and spirv-tools. * Upgrade submodule version of glslang in external. * Add fPIC to build options of slang-spirv-tools * Upgrade slang-binaries to have new glslang. * Fix issues with Windows slang-glslang binaries, via update of slang-binaries used. * Small improvements to glslang building process documentation. Co-authored-by: Tim Foley <tfoleyNV@users.noreply.github.com>
Diffstat (limited to 'external/spirv-tools-generated/README.md')
-rw-r--r--external/spirv-tools-generated/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/external/spirv-tools-generated/README.md b/external/spirv-tools-generated/README.md
new file mode 100644
index 000000000..84cdef4bb
--- /dev/null
+++ b/external/spirv-tools-generated/README.md
@@ -0,0 +1,26 @@
+Slang SPIR-V Tools
+==================
+
+The spir-v tools are needed in the Slang project in order to be able to build glslang. We don't necessarily want/neet to build all the spir-v tools - but we do need the files that are generated as part of this process. Those files are then stored in this folder, so that they can just be used without needing to be created as part of the Slang build process.
+
+To build spirv-tools we need [cmake](https://cmake.org/download/). On windows we can use cmake with the gui interface.
+
+Inside the `external/spirv-tools` directory make a directory `build.vs` which is where we are going to generate all the files.
+
+You may need to make sure you have the other dependencies that spirv-tools requires as described on their github main page...
+
+https://github.com/KhronosGroup/SPIRV-Tools
+
+At the time of writing in `external/spirv-tools` the following were needed
+
+```
+git clone https://github.com/KhronosGroup/SPIRV-Headers.git external/spirv-headers
+git clone https://github.com/google/effcee.git external/effcee
+git clone https://github.com/google/re2.git external/re2
+```
+
+Next run the cmake gui. Set the source path to be `external/spirv-tools` (in the slang directory), and then set the 'where to build binaries' to `external/spirv-tools/build.vs` (or however you named that file. Then click `configure` and once that is done 'generate'.
+
+Now go into to the `build.vs` directory and open `spirv-tools.sln` with Visual Studio and compile. This will generate many of the files needed, once regular C++/C compilation has started all of the files should have been created.
+
+Take the files with '.inc' and '.h' extensions from the build.vs directory and copy it into this directory. \ No newline at end of file