Merge pull request SaschaWillems#1186 from SaschaWillems/slang_shaders

[WIP] Add Slang shaders

Author: SaschaWillems

.gitignore

@@ -240,4 +240,6 @@ android/.idea/**
 
 libs/vulkan/*.so
 
-.vscode/*
+.vscode/*
+
+__pycache__**

README.md

@@ -68,7 +68,7 @@ Once built, examples can be run from the bin directory. The list of available co
  -vs, --vsync: Enable V-Sync
  -f, --fullscreen: Start in fullscreen mode
  -w, --width: Set window width
- -s, --shaders: Select shader type to use (glsl or hlsl)
+ -s, --shaders: Select shader type to use (glsl, slang, hlsl)
  -g, --gpu: Select GPU to run on
  -gl, --listgpus: Display a list of available Vulkan devices
  -b, --benchmark: Run example in benchmark mode
@@ -83,7 +83,7 @@ Note that some examples require specific device features, and if you are on a mu
 
 ## Shaders
 
-Vulkan consumes shaders in an intermediate representation called SPIR-V. This makes it possible to use different shader languages by compiling them to that bytecode format. The primary shader language used here is [GLSL](shaders/glsl) but most samples also come with [HLSL](shaders/hlsl) shader sources.
+Vulkan consumes shaders in an intermediate representation called SPIR-V. This makes it possible to use different shader languages by compiling them to that bytecode format. The primary shader language used here is [GLSL](shaders/glsl), most samples also come with [slang](shaders/slang/) and [HLSL](shaders/hlsl) shader sources, making it easy to compare the differences between those shading languages.
 
 ## A note on synchronization
 

base/vulkanexamplebase.cpp

@@ -89,6 +89,15 @@ VkResult VulkanExampleBase::createInstance()
 		}
 	}
 
+	// Shaders generated by Slang require a certain SPIR-V environment that can't be satisfied by Vulkan 1.0, so we need to expliclity up that to at least 1.1 and enable some required extensions
+	if (shaderDir == "slang") {
+		if (apiVersion < VK_API_VERSION_1_1) {
+			apiVersion = VK_API_VERSION_1_1;
+		}
+		enabledDeviceExtensions.push_back(VK_KHR_SPIRV_1_4_EXTENSION_NAME);
+		enabledDeviceExtensions.push_back(VK_KHR_SHADER_FLOAT_CONTROLS_EXTENSION_NAME);
+	}
+
 	VkApplicationInfo appInfo{};
 	appInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
 	appInfo.pApplicationName = name.c_str();

examples/computecullandlod/computecullandlod.cpp

@@ -391,8 +391,8 @@ class VulkanExample : public VulkanExampleBase
 		    vks::initializers::vertexInputAttributeDescription(0, 2, VK_FORMAT_R32G32B32_SFLOAT, offsetof(vkglTF::Vertex, color)),	// Location 2: Texture coordinates
 		    // Per-Instance attributes
 		    // These are fetched for each instance rendered
-		    vks::initializers::vertexInputAttributeDescription(1, 4, VK_FORMAT_R32G32B32_SFLOAT, offsetof(InstanceData, pos)),	// Location 4: Position
-		    vks::initializers::vertexInputAttributeDescription(1, 5, VK_FORMAT_R32_SFLOAT, offsetof(InstanceData, scale)),		// Location 5: Scale
+		    vks::initializers::vertexInputAttributeDescription(1, 3, VK_FORMAT_R32G32B32_SFLOAT, offsetof(InstanceData, pos)),	// Location 4: Position
+		    vks::initializers::vertexInputAttributeDescription(1, 4, VK_FORMAT_R32_SFLOAT, offsetof(InstanceData, scale)),		// Location 5: Scale
 		};
 		inputState.pVertexBindingDescriptions = bindingDescriptions.data();
 		inputState.pVertexAttributeDescriptions = attributeDescriptions.data();

examples/computeheadless/computeheadless.cpp

@@ -82,6 +82,8 @@ class VulkanExample
 
 	VkDebugReportCallbackEXT debugReportCallback{};
 
+	std::string shaderDir = "glsl";
+
 	VkResult createBuffer(VkBufferUsageFlags usageFlags, VkMemoryPropertyFlags memoryPropertyFlags, VkBuffer *buffer, VkDeviceMemory *memory, VkDeviceSize size, void *data = nullptr)
 	{
 		// Create the buffer handle
@@ -132,11 +134,19 @@ class VulkanExample
 		vks::android::loadVulkanLibrary();
 #endif
 
+		if (commandLineParser.isSet("shaders")) {
+			shaderDir = commandLineParser.getValueAsString("shaders", "glsl");
+		}
+
 		VkApplicationInfo appInfo = {};
 		appInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
 		appInfo.pApplicationName = "Vulkan headless example";
 		appInfo.pEngineName = "VulkanExample";
 		appInfo.apiVersion = VK_API_VERSION_1_0;
+		// Shaders generated by Slang require a certain SPIR-V environment that can't be satisfied by Vulkan 1.0, so we need to expliclity up that to at least 1.1 and enable some required extensions
+		if (shaderDir == "slang") {
+			appInfo.apiVersion = VK_API_VERSION_1_1;
+		}
 
 		/*
 			Vulkan instance creation (without surface extensions)
@@ -159,7 +169,7 @@ class VulkanExample
 		bool layersAvailable = true;
 		for (auto layerName : validationLayers) {
 			bool layerAvailable = false;
-			for (auto instanceLayer : instanceLayers) {
+			for (auto& instanceLayer : instanceLayers) {
 				if (strcmp(instanceLayer.layerName, layerName) == 0) {
 					layerAvailable = true;
 					break;
@@ -260,8 +270,15 @@ class VulkanExample
 		deviceCreateInfo.queueCreateInfoCount = 1;
 		deviceCreateInfo.pQueueCreateInfos = &queueCreateInfo;
 		std::vector<const char*> deviceExtensions = {};
+
+		// Shaders generated by Slang require a certain SPIR-V environment that can't be satisfied by Vulkan 1.0, so we need to expliclity up that to at least 1.1 and enable some required extensions
+		if (shaderDir == "slang") {
+			deviceExtensions.push_back(VK_KHR_SPIRV_1_4_EXTENSION_NAME);
+			deviceExtensions.push_back(VK_KHR_SHADER_FLOAT_CONTROLS_EXTENSION_NAME);
+		}
+
 #if (defined(VK_USE_PLATFORM_MACOS_MVK) || defined(VK_USE_PLATFORM_METAL_EXT)) && defined(VK_KHR_portability_subset)
-		// SRS - When running on macOS with MoltenVK and VK_KHR_portability_subset is defined and supported by the device, enable the extension
+		// When running on macOS with MoltenVK and VK_KHR_portability_subset is defined and supported by the device, enable the extension
 		uint32_t deviceExtCount = 0;
 		vkEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &deviceExtCount, nullptr);
 		if (deviceExtCount > 0)
@@ -410,10 +427,6 @@ class VulkanExample
 			VkSpecializationMapEntry specializationMapEntry = vks::initializers::specializationMapEntry(0, 0, sizeof(uint32_t));
 			VkSpecializationInfo specializationInfo = vks::initializers::specializationInfo(1, &specializationMapEntry, sizeof(SpecializationData), &specializationData);
 
-			std::string shaderDir = "glsl";
-			if (commandLineParser.isSet("shaders")) {
-				shaderDir = commandLineParser.getValueAsString("shaders", "glsl");
-			}
 			const std::string shadersPath = getShaderBasePath() + shaderDir + "/computeheadless/";
 
 			VkPipelineShaderStageCreateInfo shaderStage = {};

examples/renderheadless/renderheadless.cpp

@@ -97,6 +97,8 @@ class VulkanExample
 
 	VkDebugReportCallbackEXT debugReportCallback{};
 
+	std::string shaderDir = "glsl";
+
 	uint32_t getMemoryTypeIndex(uint32_t typeBits, VkMemoryPropertyFlags properties) {
 		VkPhysicalDeviceMemoryProperties deviceMemoryProperties;
 		vkGetPhysicalDeviceMemoryProperties(physicalDevice, &deviceMemoryProperties);
@@ -163,11 +165,19 @@ class VulkanExample
 		vks::android::loadVulkanLibrary();
 #endif
 
+		if (commandLineParser.isSet("shaders")) {
+			shaderDir = commandLineParser.getValueAsString("shaders", "glsl");
+		}
+
 		VkApplicationInfo appInfo = {};
 		appInfo.sType = VK_STRUCTURE_TYPE_APPLICATION_INFO;
 		appInfo.pApplicationName = "Vulkan headless example";
 		appInfo.pEngineName = "VulkanExample";
 		appInfo.apiVersion = VK_API_VERSION_1_0;
+		// Shaders generated by Slang require a certain SPIR-V environment that can't be satisfied by Vulkan 1.0, so we need to expliclity up that to at least 1.1 and enable some required extensions
+		if (shaderDir == "slang") {
+			appInfo.apiVersion = VK_API_VERSION_1_1;
+		}
 
 		/*
 			Vulkan instance creation (without surface extensions)
@@ -190,7 +200,7 @@ class VulkanExample
 		bool layersAvailable = true;
 		for (auto layerName : validationLayers) {
 			bool layerAvailable = false;
-			for (auto instanceLayer : instanceLayers) {
+			for (auto& instanceLayer : instanceLayers) {
 				if (strcmp(instanceLayer.layerName, layerName) == 0) {
 					layerAvailable = true;
 					break;
@@ -290,8 +300,15 @@ class VulkanExample
 		deviceCreateInfo.queueCreateInfoCount = 1;
 		deviceCreateInfo.pQueueCreateInfos = &queueCreateInfo;
 		std::vector<const char*> deviceExtensions = {};
+
+		// Shaders generated by Slang require a certain SPIR-V environment that can't be satisfied by Vulkan 1.0, so we need to expliclity up that to at least 1.1 and enable some required extensions
+		if (shaderDir == "slang") {
+			deviceExtensions.push_back(VK_KHR_SPIRV_1_4_EXTENSION_NAME);
+			deviceExtensions.push_back(VK_KHR_SHADER_FLOAT_CONTROLS_EXTENSION_NAME);
+		}
+
 #if (defined(VK_USE_PLATFORM_MACOS_MVK) || defined(VK_USE_PLATFORM_METAL_EXT)) && defined(VK_KHR_portability_subset)
-		// SRS - When running on macOS with MoltenVK and VK_KHR_portability_subset is defined and supported by the device, enable the extension
+		// When running on macOS with MoltenVK and VK_KHR_portability_subset is defined and supported by the device, enable the extension
 		uint32_t deviceExtCount = 0;
 		vkEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &deviceExtCount, nullptr);
 		if (deviceExtCount > 0)
@@ -643,7 +660,6 @@ class VulkanExample
 
 			pipelineCreateInfo.pVertexInputState = &vertexInputState;
 
-			std::string shaderDir = "glsl";
 			if (commandLineParser.isSet("shaders")) {
 				shaderDir = commandLineParser.getValueAsString("shaders", "glsl");
 			}

examples/shadowmappingcascade/shadowmappingcascade.cpp

@@ -1,10 +1,8 @@
 /*
 	Vulkan Example - Cascaded shadow mapping for directional light sources
-	Copyright by Sascha Willems - www.saschawillems.de
+	Copyright (c) 2016-2025 by Sascha Willems - www.saschawillems.de
 	This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
-*/
 
-/*
 	This example implements projective cascaded shadow mapping. This technique splits up the camera frustum into
 	multiple frustums with each getting its own full-res shadow map, implemented as a layered depth-only image.
 	The shader then selects the proper shadow map layer depending on what split of the frustum the depth value
@@ -175,7 +173,7 @@ class VulkanExample : public VulkanExampleBase
 		vkCmdBindDescriptorSets(commandBuffer, VK_PIPELINE_BIND_POINT_GRAPHICS, pipelineLayout, 0, 1, &descriptorSet, 0, nullptr);
 
 		// Floor
-		vkCmdPushConstants(commandBuffer, pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
+		vkCmdPushConstants(commandBuffer, pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT | VK_SHADER_STAGE_FRAGMENT_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
 		models.terrain.draw(commandBuffer, vkglTF::RenderFlags::BindImages, pipelineLayout);
 
 		// Trees
@@ -189,7 +187,7 @@ class VulkanExample : public VulkanExampleBase
 
 		for (auto& position : positions) {
 			pushConstBlock.position = glm::vec4(position, 0.0f);
-			vkCmdPushConstants(commandBuffer, pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
+			vkCmdPushConstants(commandBuffer, pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT | VK_SHADER_STAGE_FRAGMENT_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
 			// This will also bind the texture images to set 1
 			models.tree.draw(commandBuffer, vkglTF::RenderFlags::BindImages, pipelineLayout);
 		}
@@ -413,7 +411,7 @@ class VulkanExample : public VulkanExampleBase
 					vkCmdBindPipeline(drawCmdBuffers[i], VK_PIPELINE_BIND_POINT_GRAPHICS, pipelines.debugShadowMap);
 					PushConstBlock pushConstBlock = {};
 					pushConstBlock.cascadeIndex = displayDepthMapCascadeIndex;
-					vkCmdPushConstants(drawCmdBuffers[i], pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
+					vkCmdPushConstants(drawCmdBuffers[i], pipelineLayout, VK_SHADER_STAGE_VERTEX_BIT | VK_SHADER_STAGE_FRAGMENT_BIT, 0, sizeof(PushConstBlock), &pushConstBlock);
 					vkCmdDraw(drawCmdBuffers[i], 3, 1, 0, 0);
 				}
 
@@ -490,7 +488,7 @@ class VulkanExample : public VulkanExampleBase
 
 		// Shared pipeline layout (scene and depth map debug display)
 		{
-			VkPushConstantRange pushConstantRange = vks::initializers::pushConstantRange(VK_SHADER_STAGE_VERTEX_BIT, sizeof(PushConstBlock), 0);
+			VkPushConstantRange pushConstantRange = vks::initializers::pushConstantRange(VK_SHADER_STAGE_VERTEX_BIT | VK_SHADER_STAGE_FRAGMENT_BIT, sizeof(PushConstBlock), 0);
 			std::array<VkDescriptorSetLayout, 2> setLayouts = { descriptorSetLayout, vkglTF::descriptorSetLayoutImage };
 			VkPipelineLayoutCreateInfo pipelineLayoutCreateInfo = vks::initializers::pipelineLayoutCreateInfo(setLayouts.data(), static_cast<uint32_t>(setLayouts.size()));
 			pipelineLayoutCreateInfo.pushConstantRangeCount = 1;
@@ -500,7 +498,7 @@ class VulkanExample : public VulkanExampleBase
 
 		// Depth pass pipeline layout
 		{
-			VkPushConstantRange pushConstantRange = vks::initializers::pushConstantRange(VK_SHADER_STAGE_VERTEX_BIT, sizeof(PushConstBlock), 0);
+			VkPushConstantRange pushConstantRange = vks::initializers::pushConstantRange(VK_SHADER_STAGE_VERTEX_BIT | VK_SHADER_STAGE_FRAGMENT_BIT, sizeof(PushConstBlock), 0);
 			std::array<VkDescriptorSetLayout, 2> setLayouts = { descriptorSetLayout, vkglTF::descriptorSetLayoutImage };
 			VkPipelineLayoutCreateInfo pipelineLayoutCreateInfo = vks::initializers::pipelineLayoutCreateInfo(setLayouts.data(), static_cast<uint32_t>(setLayouts.size()));
 			pipelineLayoutCreateInfo.pushConstantRangeCount = 1;

shaders/README.md

@@ -1,3 +1,9 @@
 # Shaders
 
-This folder contains the shaders used by the samples. Source files are available as GLSL and HLSL and also come with precompiled SPIR-V files that are consumed by the samples. To recompile shaders you can use the `compileshaders.py` scripts in the respective folders or any other means that can generate Vulkan SPIR-V from GLSL or HLSL. One such option is [this extension for Visual Studio](https://github.com/SaschaWillems/SPIRV-VSExtension).
+This folder contains the shaders used by the samples. Source files are available in GLSL, HLSL and [slang](https://shader-slang.org/) and also come with precompiled SPIR-V files that are consumed by the samples. To recompile shaders you can use the `compileshaders.py` scripts in the respective folders or any other means that can generate Vulkan SPIR-V from GLSL, HLSL or slang. One such option is [this extension for Visual Studio](https://github.com/SaschaWillems/SPIRV-VSExtension).
+
+Note that not all samples may come with all shading language variants. So some samples that have GLSL source files might not come with HLSL and/or slang source files.
+
+A note for using **slang** shaders: These require a different SPIR-V environment than glsl/hlsl. When selecting slang shaders, the base requirement for all samples is raised to at least Vulkan 1.1 with the SPIRV 1.4 extension.
+
+If you want to compile **slang** shaders to SPIR-V, please use the latest release from [here](https://github.com/shader-slang/slang/releases) to get the latest bug fixes and features required for some of the samples.

shaders/glsl/computecullandlod/cull.comp.spv

@@ -6,8 +6,8 @@ layout (location = 1) in vec3 inNormal;
 layout (location = 2) in vec3 inColor;
 
 // Instanced attributes
-layout (location = 4) in vec3 instancePos;
-layout (location = 5) in float instanceScale;
+layout (location = 3) in vec3 instancePos;
+layout (location = 4) in float instanceScale;
 
 layout (binding = 0) uniform UBO 
 {