dxgi: share surface_capabilities + typeless-format helpers across DX12/Vulkan

Author: cwfitzgerald

wgpu-hal/Cargo.toml

@@ -117,6 +117,7 @@ vulkan = [
     "windows/Win32_Graphics_DirectComposition",
     "windows/Win32_Security",
     "windows/Win32_System_Threading",
+    "windows/Win32_UI_WindowsAndMessaging",
 ]
 gles = [
     "dep:arrayvec",

wgpu-hal/src/auxil/dxgi/conv.rs

@@ -117,6 +117,28 @@ pub fn map_texture_format_nosrgb(format: wgt::TextureFormat) -> Dxgi::Common::DX
     }
 }
 
+/// The typeless DXGI format family for `format`, for the color formats wgpu may view as both their
+/// sRGB and non-sRGB form. Returns `None` for formats with no such castable typeless family.
+///
+/// Shared by the DX12 resource-creation path ([`map_texture_format_for_resource`]) and the Windows
+/// Vulkan DXGI interop swapchain, which creates its shared interop textures typeless so the imported
+/// Vulkan image can be viewed through either form.
+pub fn map_texture_format_typeless(
+    format: wgt::TextureFormat,
+) -> Option<Dxgi::Common::DXGI_FORMAT> {
+    use wgt::TextureFormat as Tf;
+    use Dxgi::Common::*;
+    Some(match format {
+        Tf::Rgba8Unorm | Tf::Rgba8UnormSrgb => DXGI_FORMAT_R8G8B8A8_TYPELESS,
+        Tf::Bgra8Unorm | Tf::Bgra8UnormSrgb => DXGI_FORMAT_B8G8R8A8_TYPELESS,
+        Tf::Bc1RgbaUnorm | Tf::Bc1RgbaUnormSrgb => DXGI_FORMAT_BC1_TYPELESS,
+        Tf::Bc2RgbaUnorm | Tf::Bc2RgbaUnormSrgb => DXGI_FORMAT_BC2_TYPELESS,
+        Tf::Bc3RgbaUnorm | Tf::Bc3RgbaUnormSrgb => DXGI_FORMAT_BC3_TYPELESS,
+        Tf::Bc7RgbaUnorm | Tf::Bc7RgbaUnormSrgb => DXGI_FORMAT_BC7_TYPELESS,
+        _ => return None,
+    })
+}
+
 // SRV and UAV can't use the depth or typeless formats
 // see https://microsoft.github.io/DirectX-Specs/d3d/PlanarDepthStencilDDISpec.html#view-creation
 #[cfg(dx12)]
@@ -204,15 +226,7 @@ pub fn map_texture_format_for_resource(
 
     // We might view this resource as srgb or non-srgb
     } else if has_view_formats {
-        match format {
-            Tf::Rgba8Unorm | Tf::Rgba8UnormSrgb => DXGI_FORMAT_R8G8B8A8_TYPELESS,
-            Tf::Bgra8Unorm | Tf::Bgra8UnormSrgb => DXGI_FORMAT_B8G8R8A8_TYPELESS,
-            Tf::Bc1RgbaUnorm | Tf::Bc1RgbaUnormSrgb => DXGI_FORMAT_BC1_TYPELESS,
-            Tf::Bc2RgbaUnorm | Tf::Bc2RgbaUnormSrgb => DXGI_FORMAT_BC2_TYPELESS,
-            Tf::Bc3RgbaUnorm | Tf::Bc3RgbaUnormSrgb => DXGI_FORMAT_BC3_TYPELESS,
-            Tf::Bc7RgbaUnorm | Tf::Bc7RgbaUnormSrgb => DXGI_FORMAT_BC7_TYPELESS,
-            format => map_texture_format(format),
-        }
+        map_texture_format_typeless(format).unwrap_or_else(|| map_texture_format(format))
 
     // We might view this resource as SRV/UAV but also as DSV
     } else if format.is_depth_stencil_format()

wgpu-hal/src/auxil/dxgi/swapchain.rs

@@ -2,7 +2,7 @@
 //! Windows Vulkan backend's DXGI interop swapchain.
 
 use parking_lot::Mutex;
-use windows::Win32::{Foundation, Graphics::Dxgi, System::Threading};
+use windows::Win32::{Foundation, Graphics::Dxgi, System::Threading, UI::WindowsAndMessaging};
 
 use crate::auxil::dxgi::{dcomp, factory::DxgiFactory};
 
@@ -151,3 +151,93 @@ pub(crate) fn map_surface_color_space(
         }
     }
 }
+
+/// The presentation capabilities of a DXGI flip-model surface; identical for both backends, since
+/// they drive the same kind of swapchain.
+pub(crate) fn surface_capabilities(
+    target: &SurfaceTarget,
+    supports_allow_tearing: bool,
+) -> crate::SurfaceCapabilities {
+    let mut present_modes = vec![wgt::PresentMode::Mailbox, wgt::PresentMode::Fifo];
+    if supports_allow_tearing {
+        present_modes.push(wgt::PresentMode::Immediate);
+    }
+
+    // `Surface::configure` applies the requested color space with
+    // `IDXGISwapChain3::SetColorSpace1`. fp16 buffers keep DXGI's scRGB interpretation
+    // (`DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709`) and `Rgb10a2Unorm` additionally supports
+    // BT.2100 PQ (HDR10).
+    //
+    // These color spaces are advertised unconditionally, not gated on whether the output is
+    // currently in HDR mode: Windows always composites in scRGB and tone-maps PQ down to an SDR
+    // output, so the color space is configurable regardless, and `CheckColorSpaceSupport`
+    // returning false does not mean it won't present. Whether HDR is actually *visible* is a
+    // separate, live question (the display-HDR query, #9739), not a configuration gate. Display-P3
+    // and HLG are never reported: DXGI has no RGB HLG swapchain color space, and P3 isn't a DXGI
+    // swapchain color space.
+    let formats = [
+        wgt::TextureFormat::Bgra8UnormSrgb,
+        wgt::TextureFormat::Bgra8Unorm,
+        wgt::TextureFormat::Rgba8UnormSrgb,
+        wgt::TextureFormat::Rgba8Unorm,
+        wgt::TextureFormat::Rgb10a2Unorm,
+        wgt::TextureFormat::Rgba16Float,
+    ]
+    .map(|format| wgt::SurfaceFormatCapabilities {
+        format,
+        color_spaces: match format {
+            wgt::TextureFormat::Rgba16Float => wgt::SurfaceColorSpaces::EXTENDED_SRGB_LINEAR,
+            wgt::TextureFormat::Rgb10a2Unorm => {
+                wgt::SurfaceColorSpaces::SRGB | wgt::SurfaceColorSpaces::BT2100_PQ
+            }
+            _ => wgt::SurfaceColorSpaces::SRGB,
+        },
+    })
+    .to_vec();
+
+    let composite_alpha_modes = match target {
+        SurfaceTarget::WndHandle(_) => vec![wgt::CompositeAlphaMode::Opaque],
+        _ => vec![
+            wgt::CompositeAlphaMode::Auto,
+            wgt::CompositeAlphaMode::Inherit,
+            wgt::CompositeAlphaMode::Opaque,
+            wgt::CompositeAlphaMode::PostMultiplied,
+            wgt::CompositeAlphaMode::PreMultiplied,
+        ],
+    };
+
+    crate::SurfaceCapabilities {
+        formats,
+        // See https://learn.microsoft.com/en-us/windows/win32/api/dxgi/nf-dxgi-idxgidevice1-setmaximumframelatency
+        maximum_frame_latency: 1..=16,
+        current_extent: surface_extent(target),
+        usage: wgt::TextureUses::COLOR_TARGET
+            | wgt::TextureUses::COPY_SRC
+            | wgt::TextureUses::COPY_DST,
+        present_modes,
+        composite_alpha_modes,
+    }
+}
+
+/// The current client-area extent of `target`'s backing window, or `None` for targets without one
+/// (the DX12 external-surface variants) or when the query fails.
+fn surface_extent(target: &SurfaceTarget) -> Option<wgt::Extent3d> {
+    let handle = match target {
+        SurfaceTarget::WndHandle(handle) | SurfaceTarget::VisualFromWndHandle { handle, .. } => {
+            *handle
+        }
+        #[allow(unreachable_patterns)]
+        _ => return None,
+    };
+    let mut rect = Default::default();
+    if unsafe { WindowsAndMessaging::GetClientRect(handle, &mut rect) }.is_ok() {
+        Some(wgt::Extent3d {
+            width: (rect.right - rect.left) as u32,
+            height: (rect.bottom - rect.top) as u32,
+            depth_or_array_layers: 1,
+        })
+    } else {
+        log::warn!("Unable to get the window client rect");
+        None
+    }
+}

wgpu-hal/src/dx12/adapter.rs

@@ -13,15 +13,14 @@ use windows::{
         },
         Foundation::{GetLastError, ERROR_NO_MORE_ITEMS},
         Graphics::{Direct3D, Direct3D12, Dxgi},
-        UI::WindowsAndMessaging,
     },
 };
 
 use super::D3D12Lib;
 use crate::{
     auxil::{
         self,
-        dxgi::{dcomp::DCompLib, factory::DxgiAdapter, result::HResult, swapchain::SurfaceTarget},
+        dxgi::{dcomp::DCompLib, factory::DxgiAdapter, result::HResult},
     },
     dx12::{device_creation::DeviceFactory, shader_compilation, FeatureLevel, ShaderModel},
 };
@@ -1285,93 +1284,10 @@ impl crate::Adapter for super::Adapter {
         &self,
         surface: &super::Surface,
     ) -> Option<crate::SurfaceCapabilities> {
-        let current_extent = {
-            match surface.target {
-                SurfaceTarget::WndHandle(wnd_handle)
-                | SurfaceTarget::VisualFromWndHandle {
-                    handle: wnd_handle, ..
-                } => {
-                    let mut rect = Default::default();
-                    if unsafe { WindowsAndMessaging::GetClientRect(wnd_handle, &mut rect) }.is_ok()
-                    {
-                        Some(wgt::Extent3d {
-                            width: (rect.right - rect.left) as u32,
-                            height: (rect.bottom - rect.top) as u32,
-                            depth_or_array_layers: 1,
-                        })
-                    } else {
-                        log::warn!("Unable to get the window client rect");
-                        None
-                    }
-                }
-                SurfaceTarget::Visual(_)
-                | SurfaceTarget::SurfaceHandle(_)
-                | SurfaceTarget::SwapChainPanel(_) => None,
-            }
-        };
-
-        let mut present_modes = vec![wgt::PresentMode::Mailbox, wgt::PresentMode::Fifo];
-        if surface.supports_allow_tearing {
-            present_modes.push(wgt::PresentMode::Immediate);
-        }
-
-        Some(crate::SurfaceCapabilities {
-            // `Surface::configure` applies the requested color space with
-            // `IDXGISwapChain3::SetColorSpace1`. fp16 buffers keep DXGI's
-            // scRGB interpretation (`DXGI_COLOR_SPACE_RGB_FULL_G10_NONE_P709`)
-            // and `Rgb10a2Unorm` additionally supports BT.2100 PQ (HDR10).
-            //
-            // These color spaces are advertised unconditionally, not gated on
-            // whether the output is currently in HDR mode: Windows always
-            // composites in scRGB and tone-maps PQ down to an SDR output, so the
-            // color space is configurable regardless, and `CheckColorSpaceSupport`
-            // returning false does not mean it won't present. Whether HDR is
-            // actually *visible* is a separate, live question (the upcoming
-            // display-HDR query, #9739), not a configuration gate. Display-P3 and
-            // HLG are never reported: DXGI has no RGB HLG swapchain color space,
-            // and P3 isn't a DXGI swapchain color space.
-            formats: [
-                wgt::TextureFormat::Bgra8UnormSrgb,
-                wgt::TextureFormat::Bgra8Unorm,
-                wgt::TextureFormat::Rgba8UnormSrgb,
-                wgt::TextureFormat::Rgba8Unorm,
-                wgt::TextureFormat::Rgb10a2Unorm,
-                wgt::TextureFormat::Rgba16Float,
-            ]
-            .map(|format| wgt::SurfaceFormatCapabilities {
-                format,
-                color_spaces: match format {
-                    wgt::TextureFormat::Rgba16Float => {
-                        wgt::SurfaceColorSpaces::EXTENDED_SRGB_LINEAR
-                    }
-                    wgt::TextureFormat::Rgb10a2Unorm => {
-                        wgt::SurfaceColorSpaces::SRGB | wgt::SurfaceColorSpaces::BT2100_PQ
-                    }
-                    _ => wgt::SurfaceColorSpaces::SRGB,
-                },
-            })
-            .to_vec(),
-            // See https://learn.microsoft.com/en-us/windows/win32/api/dxgi/nf-dxgi-idxgidevice1-setmaximumframelatency
-            maximum_frame_latency: 1..=16,
-            current_extent,
-            usage: wgt::TextureUses::COLOR_TARGET
-                | wgt::TextureUses::COPY_SRC
-                | wgt::TextureUses::COPY_DST,
-            present_modes,
-            composite_alpha_modes: match surface.target {
-                SurfaceTarget::WndHandle(_) => vec![wgt::CompositeAlphaMode::Opaque],
-                SurfaceTarget::Visual(_)
-                | SurfaceTarget::VisualFromWndHandle { .. }
-                | SurfaceTarget::SurfaceHandle(_)
-                | SurfaceTarget::SwapChainPanel(_) => vec![
-                    wgt::CompositeAlphaMode::Auto,
-                    wgt::CompositeAlphaMode::Inherit,
-                    wgt::CompositeAlphaMode::Opaque,
-                    wgt::CompositeAlphaMode::PostMultiplied,
-                    wgt::CompositeAlphaMode::PreMultiplied,
-                ],
-            },
-        })
+        Some(auxil::dxgi::swapchain::surface_capabilities(
+            &surface.target,
+            surface.supports_allow_tearing,
+        ))
     }
 
     unsafe fn surface_display_hdr_info(