vulkano-shaders - proc macros 2.0 (#1062)

* vulkano_shaders_derive exposes a proc_macro instead of a proc_macro_derive
* move vulkano_shader out of vulkano_shaders_derive and deprecate vulkano_shaders_derive
* Update documentation
* Move vulkano_shader! to root of mod, so it works with rust 1.30

Author: rukai

Diff for: CHANGELOG.md

@@ -1,6 +1,12 @@
 # Unreleased (Breaking)
 
-- `vulkano_shaders::reflect` now returns `Result<proc_macro2::TokenStream, Error>` instead of `Result<String, Error>`
+- Export features and device extensions from the device module instead of the instance module
+    +   `instance::Features` -> `device::Features`
+    +   `instance::DeviceExtensions` -> `device::DeviceExtensions`
+    +   `instance::RawDeviceExtensions` -> `device::RawDeviceExtensions`
+- Added `vulkano_shaders::vulkano_shader` proc macro, use this instead of `vulkano_shader_deriver::VulkanoShaders`.
+- The entire `vulkano_shader_derive` crate is deprecated.
+- `vulkano_shaders::{reflect, compile, Error}` are no longer public.
 - Removed mir support, as it is being removed from the vulkan spec.
 - Remove vulkano_shaders::build_glsl_shaders
 - Split `PersistentDescriptorSetError::MissingUsage` into `MissingImageUsage` and `MissingBufferUsage`
@@ -14,10 +20,6 @@
 
 # Version 0.10.0 (2018-08-10)
 
-- Export features and device extensions from the device module instead of the instance module
-    +   `instance::Features` -> `device::Features`
-    +   `instance::DeviceExtensions` -> `device::DeviceExtensions`
-    +   `instance::RawDeviceExtensions` -> `device::RawDeviceExtensions`
 - Use dynamically loaded `libvulkan` like on other platforms instead of linking to MoltenVK on macOS
 - Updated winit to version 0.17.
 - Allow custom implementations of `RenderPassDesc` to specify `VK_SUBPASS_EXTERNAL` as a dependency source or destination

Diff for: examples/Cargo.toml

@@ -6,7 +6,7 @@ publish = false
 
 [dependencies]
 vulkano = { path = "../vulkano" }
-vulkano-shader-derive = { path = "../vulkano-shader-derive" }
+vulkano-shaders = { path = "../vulkano-shaders" }
 vulkano-win = { path = "../vulkano-win" }
 cgmath = "0.16.1"
 image = "0.20.0"

Diff for: examples/src/bin/basic-compute-shader.rs

@@ -15,8 +15,7 @@
 
 // Note that since we don't create any window, fewer imports are needed.
 extern crate vulkano;
-#[macro_use]
-extern crate vulkano_shader_derive;
+extern crate vulkano_shaders;
 
 use vulkano::buffer::BufferUsage;
 use vulkano::buffer::CpuAccessibleBuffer;
@@ -29,9 +28,28 @@ use vulkano::instance::InstanceExtensions;
 use vulkano::pipeline::ComputePipeline;
 use vulkano::sync::now;
 use vulkano::sync::GpuFuture;
+use vulkano_shaders::vulkano_shader;
 
 use std::sync::Arc;
 
+vulkano_shader!{
+    mod_name: cs,
+    ty: "compute",
+    src: "
+#version 450
+
+layout(local_size_x = 64, local_size_y = 1, local_size_z = 1) in;
+
+layout(set = 0, binding = 0) buffer Data {
+    uint data[];
+} data;
+
+void main() {
+    uint idx = gl_GlobalInvocationID.x;
+    data.data[idx] *= 12;
+}"
+}
+
 fn main() {
     // As with other examples, the first step is to create an instance.
     let instance = Instance::new(None, &InstanceExtensions::none(), None)
@@ -79,28 +97,6 @@ fn main() {
     // If you are familiar with graphics pipeline, the principle is the same except that compute
     // pipelines are much simpler to create.
     let pipeline = Arc::new({
-        // TODO: explain
-        #[allow(dead_code)]
-        mod cs {
-            #[derive(VulkanoShader)]
-            #[ty = "compute"]
-            #[src = "
-#version 450
-
-layout(local_size_x = 64, local_size_y = 1, local_size_z = 1) in;
-
-layout(set = 0, binding = 0) buffer Data {
-    uint data[];
-} data;
-
-void main() {
-    uint idx = gl_GlobalInvocationID.x;
-    data.data[idx] *= 12;
-}"
-]
-            struct Dummy;
-        }
-
         let shader = cs::Shader::load(device.clone())
             .expect("failed to create shader module");
         ComputePipeline::new(device.clone(), &shader.main_entry_point(), &())

Diff for: examples/src/bin/deferred/frame/ambient_lighting_system.rs

@@ -23,6 +23,7 @@ use vulkano::pipeline::blend::BlendOp;
 use vulkano::pipeline::GraphicsPipeline;
 use vulkano::pipeline::GraphicsPipelineAbstract;
 use vulkano::pipeline::viewport::Viewport;
+use vulkano_shaders::vulkano_shader;
 
 use std::sync::Arc;
 
@@ -142,27 +143,23 @@ struct Vertex {
 }
 impl_vertex!(Vertex, position);
 
-mod vs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "vertex"]
-    #[src = "
+vulkano_shader!{
+    mod_name: vs,
+    ty: "vertex",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 position;
 
 void main() {
     gl_Position = vec4(position, 0.0, 1.0);
-}
-"]
-    struct Dummy;
+}"
 }
 
-mod fs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "fragment"]
-    #[src = "
+vulkano_shader!{
+    mod_name: fs,
+    ty: "fragment",
+    src: "
 #version 450
 
 // The `color_input` parameter of the `draw` method.
@@ -180,7 +177,5 @@ void main() {
     vec3 in_diffuse = subpassLoad(u_diffuse).rgb;
     f_color.rgb = push_constants.color.rgb * in_diffuse;
     f_color.a = 1.0;
-}
-"]
-    struct Dummy;
+}"
 }

Diff for: examples/src/bin/deferred/frame/directional_lighting_system.rs

@@ -23,6 +23,7 @@ use vulkano::pipeline::blend::BlendOp;
 use vulkano::pipeline::GraphicsPipeline;
 use vulkano::pipeline::GraphicsPipelineAbstract;
 use vulkano::pipeline::viewport::Viewport;
+use vulkano_shaders::vulkano_shader;
 use cgmath::Vector3;
 
 use std::sync::Arc;
@@ -154,27 +155,23 @@ struct Vertex {
 }
 impl_vertex!(Vertex, position);
 
-mod vs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "vertex"]
-    #[src = "
+vulkano_shader!{
+    mod_name: vs,
+    ty: "vertex",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 position;
 
 void main() {
     gl_Position = vec4(position, 0.0, 1.0);
-}
-"]
-    struct Dummy;
+}"
 }
 
-mod fs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "fragment"]
-    #[src = "
+vulkano_shader!{
+    mod_name: fs,
+    ty: "fragment",
+    src: "
 #version 450
 
 // The `color_input` parameter of the `draw` method.
@@ -203,7 +200,5 @@ void main() {
     vec3 in_diffuse = subpassLoad(u_diffuse).rgb;
     f_color.rgb = light_percent * push_constants.color.rgb * in_diffuse;
     f_color.a = 1.0;
-}
-"]
-    struct Dummy;
+}"
 }

Diff for: examples/src/bin/deferred/frame/point_lighting_system.rs

@@ -23,6 +23,7 @@ use vulkano::pipeline::blend::BlendOp;
 use vulkano::pipeline::GraphicsPipeline;
 use vulkano::pipeline::GraphicsPipelineAbstract;
 use vulkano::pipeline::viewport::Viewport;
+use vulkano_shaders::vulkano_shader;
 use cgmath::Matrix4;
 use cgmath::Vector3;
 
@@ -168,11 +169,10 @@ struct Vertex {
 }
 impl_vertex!(Vertex, position);
 
-mod vs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "vertex"]
-    #[src = "
+vulkano_shader!{
+    mod_name: vs,
+    ty: "vertex",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 position;
@@ -181,16 +181,13 @@ layout(location = 0) out vec2 v_screen_coords;
 void main() {
     v_screen_coords = position;
     gl_Position = vec4(position, 0.0, 1.0);
-}
-"]
-    struct Dummy;
+}"
 }
 
-mod fs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "fragment"]
-    #[src = "
+vulkano_shader!{
+    mod_name: fs,
+    ty: "fragment",
+    src: "
 #version 450
 
 // The `color_input` parameter of the `draw` method.
@@ -236,7 +233,5 @@ void main() {
     vec3 in_diffuse = subpassLoad(u_diffuse).rgb;
     f_color.rgb = push_constants.color.rgb * light_percent * in_diffuse;
     f_color.a = 1.0;
-}
-"]
-    struct Dummy;
+}"
 }

Diff for: examples/src/bin/deferred/main.rs

@@ -29,8 +29,7 @@
 extern crate cgmath;
 #[macro_use]
 extern crate vulkano;
-#[macro_use]
-extern crate vulkano_shader_derive;
+extern crate vulkano_shaders;
 extern crate winit;
 extern crate vulkano_win;
 

Diff for: examples/src/bin/deferred/triangle_draw_system.rs

@@ -18,6 +18,7 @@ use vulkano::framebuffer::Subpass;
 use vulkano::pipeline::GraphicsPipeline;
 use vulkano::pipeline::GraphicsPipelineAbstract;
 use vulkano::pipeline::viewport::Viewport;
+use vulkano_shaders::vulkano_shader;
 
 use std::sync::Arc;
 
@@ -94,27 +95,23 @@ struct Vertex {
 }
 impl_vertex!(Vertex, position);
 
-mod vs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "vertex"]
-    #[src = "
+vulkano_shader!{
+    mod_name: vs,
+    ty: "vertex",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 position;
 
 void main() {
     gl_Position = vec4(position, 0.0, 1.0);
-}
-"]
-    struct Dummy;
+}"
 }
 
-mod fs {
-    #[derive(VulkanoShader)]
-    #[allow(dead_code)]
-    #[ty = "fragment"]
-    #[src = "
+vulkano_shader!{
+    mod_name: fs,
+    ty: "fragment",
+    src: "
 #version 450
 
 layout(location = 0) out vec4 f_color;
@@ -123,7 +120,5 @@ layout(location = 1) out vec3 f_normal;
 void main() {
     f_color = vec4(1.0, 1.0, 1.0, 1.0);
     f_normal = vec3(0.0, 0.0, 1.0);
-}
-"]
-    struct Dummy;
+}"
 }

Diff for: examples/src/bin/image/main.rs

@@ -13,12 +13,12 @@ extern crate winit;
 
 #[macro_use]
 extern crate vulkano;
-#[macro_use]
-extern crate vulkano_shader_derive;
+extern crate vulkano_shaders;
 extern crate vulkano_win;
 
 use vulkano_win::VkSurfaceBuild;
 use vulkano::sync::GpuFuture;
+use vulkano_shaders::vulkano_shader;
 
 use std::sync::Arc;
 
@@ -242,10 +242,10 @@ fn main() {
     }
 }
 
-mod vs {
-    #[derive(VulkanoShader)]
-    #[ty = "vertex"]
-    #[src = "
+vulkano_shader!{
+    mod_name: vs,
+    ty: "vertex",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 position;
@@ -254,16 +254,13 @@ layout(location = 0) out vec2 tex_coords;
 void main() {
     gl_Position = vec4(position, 0.0, 1.0);
     tex_coords = position + vec2(0.5);
-}
-"]
-    #[allow(dead_code)]
-    struct Dummy;
+}"
 }
 
-mod fs {
-    #[derive(VulkanoShader)]
-    #[ty = "fragment"]
-    #[src = "
+vulkano_shader!{
+    mod_name: fs,
+    ty: "fragment",
+    src: "
 #version 450
 
 layout(location = 0) in vec2 tex_coords;
@@ -273,8 +270,5 @@ layout(set = 0, binding = 0) uniform sampler2D tex;
 
 void main() {
     f_color = texture(tex, tex_coords);
-}
-"]
-    #[allow(dead_code)]
-    struct Dummy;
+}"
 }