Enable debug information for Vulkan shaders (bkaradzic#3193)

* Enable debug information for Vulkan shaders * Enable debug information for Metal shaders
jay3d · Dec 7, 2023 · c43d90b · c43d90b
1 parent 40b3ef8
commit c43d90b
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 4 deletions.
diff --git a/docs/tools.rst b/docs/tools.rst
@@ -199,9 +199,12 @@ Options:
   --varyingdef <file path>  A varying.def.sc's file path.
   --verbose                 Be verbose.
 
-(DX9 and DX11 only):
+(Vulkan, DirectX and Metal):
 
   --debug                   Debug information.
+
+(DirectX only):
+
   --disasm                  Disassemble a compiled shader.
   -O <level>                Set optimization level.
                             Can be 0–3.

diff --git a/tools/shaderc/shaderc.cpp b/tools/shaderc/shaderc.cpp
@@ -1054,10 +1054,15 @@ namespace bgfx
 			  "      --verbose                 Be verbose.\n"
 
 			  "\n"
-			  "(DX9 and DX11 only):\n"
+			  "(Vulkan, DirectX and Metal):\n"
 
 			  "\n"
 			  "      --debug                   Debug information.\n"
+
+			  "\n"
+			  "(DirectX only):\n"
+
+			  "\n"
 			  "      --disasm                  Disassemble compiled shader.\n"
 			  "  -O <level>                    Set optimization level. Can be 0 to 3.\n"
 			  "      --Werror                  Treat warnings as errors.\n"

diff --git a/tools/shaderc/shaderc_metal.cpp b/tools/shaderc/shaderc_metal.cpp
@@ -286,6 +286,7 @@ namespace bgfx { namespace metal
 			| EShMsgReadHlsl
 			| EShMsgVulkanRules
 			| EShMsgSpvRules
+			| EShMsgDebugInfo
 			);
 
 		shader->setEntryPoint("main");
@@ -495,7 +496,10 @@ namespace bgfx { namespace metal
 				std::vector<uint32_t> spirv;
 
 				glslang::SpvOptions options;
-				options.disableOptimizer = false;
+				options.disableOptimizer = _options.debugInformation;
+				options.generateDebugInfo = _options.debugInformation;
+				options.emitNonSemanticShaderDebugInfo = _options.debugInformation;
+				options.emitNonSemanticShaderDebugSource = _options.debugInformation;
 
 				glslang::GlslangToSpv(*intermediate, spirv, &options);
 

diff --git a/tools/shaderc/shaderc_spirv.cpp b/tools/shaderc/shaderc_spirv.cpp
@@ -461,6 +461,7 @@ namespace bgfx { namespace spirv
 			| EShMsgReadHlsl
 			| EShMsgVulkanRules
 			| EShMsgSpvRules
+			| EShMsgDebugInfo
 			);
 
 		shader->setEntryPoint("main");
@@ -705,7 +706,10 @@ namespace bgfx { namespace spirv
 				std::vector<uint32_t> spirv;
 
 				glslang::SpvOptions options;
-				options.disableOptimizer = false;
+				options.disableOptimizer = _options.debugInformation;
+				options.generateDebugInfo = _options.debugInformation;
+				options.emitNonSemanticShaderDebugInfo = _options.debugInformation;
+				options.emitNonSemanticShaderDebugSource = _options.debugInformation;
 
 				glslang::GlslangToSpv(*intermediate, spirv, &options);