Use shaderc instead of glsl-to-spirv for shader compilation (#947)

* Use shaderc instead of glsl-to-spirv for shader compilation
* added some setup notes

.gitlab-ci.yml

@@ -13,7 +13,6 @@ stages:
 job1:
   stage: test
   script:
-    - cargo test -v --manifest-path glsl-to-spirv/Cargo.toml
     - cargo test -v --manifest-path vulkano-shaders/Cargo.toml
     - cargo test --no-run -v --manifest-path vulkano/Cargo.toml
 

.travis.yml

@@ -22,7 +22,7 @@ addons:
     - cmake-data
 
 script:
-    - cargo test --all -j 1
+    - travis_wait cargo test --all -j 1
     - cd examples
     - cargo build
     - cd .. # this is very important or else the below `cargo publish` will fail
@@ -40,10 +40,6 @@ after_success:
         [ $TRAVIS_BRANCH = master ] &&
         [ $TRAVIS_PULL_REQUEST = false ] &&
         cargo publish --token ${CRATESIO_TOKEN} --manifest-path vulkano-win/Cargo.toml
-    - |
-        [ $TRAVIS_BRANCH = master ] &&
-        [ $TRAVIS_PULL_REQUEST = false ] &&
-        cargo publish --token ${CRATESIO_TOKEN} --manifest-path glsl-to-spirv/Cargo.toml
     - |
         [ $TRAVIS_BRANCH = master ] &&
         [ $TRAVIS_PULL_REQUEST = false ] &&

CHANGELOG.md

@@ -5,6 +5,8 @@
 - Fix instance_count when using draw_index with instance buffers
 - Added a `reinterpret` function to `BufferSlice`
 
+- Use [google/shaderc](/~https://github.com/google/shaderc-rs) for shader compilation
+
 # Version 0.10.0 (2018-08-10)
 
 - Use dynamically loaded `libvulkan` like on other platforms instead of linking to MoltenVK on macOS

Cargo.toml

@@ -1,7 +1,6 @@
 [workspace]
 members = [
     "examples",
-    "glsl-to-spirv",
     "vk-sys",
     "vulkano",
     "vulkano-shaders",

README.md

@@ -51,7 +51,17 @@ To get started you are encouraged to use the following resources:
     examples in the repo and also a list of projects that use vulkano.
 *   [docs.rs](https://docs.rs/vulkano) - Full Vulkano API documentation
 
-## macOS and iOS Setup
+## Setup
+
+Vulkano uses [shaderc-rs](/~https://github.com/google/shaderc-rs) for shader compilation. In order to
+build the shaderc-rs crate the following tools must be installed and available on `PATH`:
+- [CMake](https://cmake.org/)
+- [Python](https://www.python.org/) (works with both Python 2.x and 3.x)
+
+These requirements can be either installed with your favourite package manager or with installers
+from the projects' websites.
+
+### macOS and iOS Specific Setup
 
 Vulkan is not natively supported by macOS and iOS. However, there exists [MoltenVK](/~https://github.com/KhronosGroup/MoltenVK)
 a Vulkan implementation on top of Apple's Metal API. This allows vulkano to build and run on macOS
@@ -107,14 +117,10 @@ This repository contains six libraries:
   easily integrate your GLSL shaders within the rest of your source code.
 - `vulkano-win` provides a safe link between vulkano and the `winit` library which can create
   a window to render to.
-- `glsl-to-spirv` can compile GLSL to SPIR-V by wrapping around `glslang`. `glsl-to-spirv` is an
-  implementation detail that you don't need to use manually if you use vulkano.
 - `vk-sys` contains raw bindings for Vulkan. You can use it even if you don't care about vulkano.
 
 Once procedural macros are stabilized in Rust, the `vulkano-shaders` and `vulkano-shader-derive`
-crates will be merged with the `vulkano` crate. The `glsl-to-spirv` crate is an implementation
-detail of vulkano and is not supposed to be used directly if you use vulkano. You are, however,
-free to use it if you want to write an alternative to vulkano.
+crates will be merged with the `vulkano` crate.
 
 In order to run tests, run `cargo test --all` at the root of the repository. Make sure your Vulkan
 driver is up to date before doing so.

vulkano-shader-derive/Cargo.toml

@@ -13,7 +13,6 @@ name = "vulkano_shader_derive"
 proc-macro = true
 
 [dependencies]
-glsl-to-spirv = { version = "0.1.6", path = "../glsl-to-spirv" }
 syn = "0.14"
 vulkano-shaders = { version = "0.10", path = "../vulkano-shaders" }
 

vulkano-shader-derive/src/lib.rs

@@ -155,7 +155,6 @@
 //! [SpecializationConstants]: https://docs.rs/vulkano/*/vulkano/pipeline/shader/trait.SpecializationConstants.html
 //! [pipeline]: https://docs.rs/vulkano/*/vulkano/pipeline/index.html
 
-extern crate glsl_to_spirv;
 extern crate proc_macro;
 extern crate syn;
 extern crate vulkano_shaders;
@@ -235,19 +234,18 @@ pub fn derive(input: TokenStream) -> TokenStream {
     }).next().expect("Can't find `ty` attribute ; put #[ty = \"vertex\"] for example.");
 
     let ty = match &ty_str[..] {
-        "vertex" => glsl_to_spirv::ShaderType::Vertex,
-        "fragment" => glsl_to_spirv::ShaderType::Fragment,
-        "geometry" => glsl_to_spirv::ShaderType::Geometry,
-        "tess_ctrl" => glsl_to_spirv::ShaderType::TessellationControl,
-        "tess_eval" => glsl_to_spirv::ShaderType::TessellationEvaluation,
-        "compute" => glsl_to_spirv::ShaderType::Compute,
+        "vertex" => vulkano_shaders::ShaderKind::Vertex,
+        "fragment" => vulkano_shaders::ShaderKind::Fragment,
+        "geometry" => vulkano_shaders::ShaderKind::Geometry,
+        "tess_ctrl" => vulkano_shaders::ShaderKind::TessControl,
+        "tess_eval" => vulkano_shaders::ShaderKind::TessEvaluation,
+        "compute" => vulkano_shaders::ShaderKind::Compute,
         _ => panic!("Unexpected shader type ; valid values: vertex, fragment, geometry, tess_ctrl, tess_eval, compute")
     };
-
-    let spirv_data = match glsl_to_spirv::compile(&source_code, ty) {
-        Ok(compiled) => compiled,
-        Err(message) => panic!("{}\nfailed to compile shader", message),
-    };
-
-    vulkano_shaders::reflect("Shader", spirv_data).unwrap().parse().unwrap()
+    let content = vulkano_shaders::compile(&source_code, ty).unwrap();
+
+    vulkano_shaders::reflect("Shader", content.as_binary())
+        .unwrap()
+        .parse()
+        .unwrap()
 }

vulkano-shaders/Cargo.toml

@@ -9,4 +9,4 @@ documentation = "http://tomaka.github.io/vulkano/vulkano/index.html"
 categories = ["rendering::graphics-api"]
 
 [dependencies]
-glsl-to-spirv = { version = "0.1.6", path = "../glsl-to-spirv" }
+shaderc = "0.3"

vulkano-shaders/examples/example.rs

@@ -7,7 +7,6 @@
 // notice may not be copied, modified, or distributed except
 // according to those terms.
 
-extern crate glsl_to_spirv;
 extern crate vulkano_shaders;
 
 fn main() {
@@ -40,7 +39,7 @@ void main() {
 
 "#;
 
-    let content = glsl_to_spirv::compile(shader, glsl_to_spirv::ShaderType::Fragment).unwrap();
-    let output = vulkano_shaders::reflect("Shader", content).unwrap();
+    let content = vulkano_shaders::compile(shader, vulkano_shaders::ShaderKind::Fragment).unwrap();
+    let output = vulkano_shaders::reflect("Shader", content.as_binary()).unwrap();
     println!("{}", output);
 }