add dxc error message formatting (#3632)

gfx-rs · Apr 10, 2023 · 4d15567 · 4d15567
1 parent 2c37608
commit 4d15567
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -131,6 +131,7 @@ By @cwfitzgerald in [#3610](https://github.com/gfx-rs/wgpu/pull/3610).
 - Improve attachment related errors. By @cwfitzgerald in [#3549](https://github.com/gfx-rs/wgpu/pull/3549)
 - Make error descriptions all upper case. By @cwfitzgerald in [#3549](https://github.com/gfx-rs/wgpu/pull/3549)
 - Don't include ANSI terminal color escape sequences in shader module validation error messages. By @jimblandy in [#3591](https://github.com/gfx-rs/wgpu/pull/3591)
+- Report error messages from DXC compile. By @Davidster in [#3632](https://github.com/gfx-rs/wgpu/pull/3632)
 
 #### WebGPU
 

diff --git a/wgpu-hal/src/dx12/shader_compilation.rs b/wgpu-hal/src/dx12/shader_compilation.rs
@@ -188,7 +188,12 @@ mod dxc {
                         Err(e) => (
                             Err(crate::PipelineError::Linkage(
                                 stage_bit,
-                                format!("DXC validation error: {:?}\n{:?}", e.0, e.1),
+                                format!(
+                                    "DXC validation error: {:?}\n{:?}",
+                                    get_error_string_from_dxc_result(&dxc_container.library, &e.0)
+                                        .unwrap_or_default(),
+                                    e.1
+                                ),
                             )),
                             log::Level::Error,
                         ),
@@ -205,7 +210,11 @@ mod dxc {
             Err(e) => (
                 Err(crate::PipelineError::Linkage(
                     stage_bit,
-                    format!("DXC compile error: {e:?}"),
+                    format!(
+                        "DXC compile error: {:?}",
+                        get_error_string_from_dxc_result(&dxc_container.library, &e.0)
+                            .unwrap_or_default()
+                    ),
                 )),
                 log::Level::Error,
             ),
@@ -240,6 +249,15 @@ mod dxc {
             }
         }
     }
+
+    fn get_error_string_from_dxc_result(
+        library: &hassle_rs::DxcLibrary,
+        error: &hassle_rs::DxcOperationResult,
+    ) -> Result<String, hassle_rs::HassleError> {
+        error
+            .get_error_buffer()
+            .and_then(|error| library.get_blob_as_string(&hassle_rs::DxcBlob::from(error)))
+    }
 }
 
 // These are stubs for when the `dxc_shader_compiler` feature is disabled.