Merge #3038

3038:  Replace `winit` with `raw-window-handle` in backend crates r=kvark a=antonok-edm

Fixes #2956, closes #2967
PR checklist:
- [x] `make` succeeds (on *nix)
- [x] `make reftests` succeeds
- [x] tested examples with the following backends: `vulkan`
- [x] `rustfmt` run on changed code

I've rebased @jchapman127's work off of the latest `master`. Unfortunately, `winit` has not yet updated past `raw-window-handle` v0.1.2, so #3037 will have to wait. Anything else that needs to be done?

Co-authored-by: James Chapman <[email protected]>

Author: bors[bot]

examples/Cargo.toml

@@ -9,7 +9,7 @@ edition = "2018"
 default = []
 metal = ["gfx-backend-metal"]
 gl = ["gfx-backend-gl", "gfx-backend-gl/glutin"]
-wgl = ["gfx-backend-gl", "gfx-backend-gl/winit", "gfx-backend-gl/wgl"]
+wgl = ["gfx-backend-gl", "gfx-backend-gl/wgl"]
 dx11 = ["gfx-backend-dx11"]
 dx12 = ["gfx-backend-dx12"]
 vulkan = ["gfx-backend-vulkan"]
@@ -57,23 +57,20 @@ features = [ "console", "Document", "Element", "HtmlElement", "Node", "Window" ]
 [dependencies.gfx-backend-vulkan]
 path = "../src/backend/vulkan"
 version = "0.3"
-features = ["winit", "x11"]
+features = ["x11"]
 optional = true
 
 [target.'cfg(any(target_os = "macos", all(target_os = "ios", target_arch = "aarch64")))'.dependencies.gfx-backend-metal]
 path = "../src/backend/metal"
 version = "0.3"
-features = ["winit"]
 optional = true
 
 [target.'cfg(windows)'.dependencies.gfx-backend-dx11]
 path = "../src/backend/dx11"
 version = "0.3"
-features = ["winit"]
 optional = true
 
 [target.'cfg(windows)'.dependencies.gfx-backend-dx12]
 path = "../src/backend/dx12"
 version = "0.3"
-features = ["winit"]
 optional = true

examples/colour-uniform/main.rs

@@ -568,7 +568,7 @@ fn create_backend(
     let window = wb.build(event_loop).unwrap();
     let instance = back::Instance::create("gfx-rs colour-uniform", 1)
         .expect("Failed to create an instance!");
-    let surface = instance.create_surface(&window);
+    let surface = instance.create_surface(&window).expect("Failed to create a surface!");
     let mut adapters = instance.enumerate_adapters();
     (
         BackendState {

examples/quad/main.rs

@@ -119,7 +119,7 @@ fn main() {
         let window = wb.build(&event_loop).unwrap();
         let instance = back::Instance::create("gfx-rs quad", 1)
             .expect("Failed to create an instance!");
-        let surface = instance.create_surface(&window);
+        let surface = instance.create_surface(&window).expect("Failed to create a surface!");
         let adapters = instance.enumerate_adapters();
         (window, instance, adapters, surface)
     };

src/backend/dx11/Cargo.toml

@@ -27,8 +27,8 @@ smallvec = "0.6"
 spirv_cross = { version = "0.16", features = ["hlsl"] }
 parking_lot = "0.9"
 winapi = { version = "0.3", features = ["basetsd","d3d11", "d3d11sdklayers", "d3dcommon","d3dcompiler","dxgi1_2","dxgi1_3","dxgi1_4", "dxgi1_5", "dxgiformat","dxgitype","handleapi","minwindef","synchapi","unknwnbase","winbase","windef","winerror","winnt","winuser"] }
-winit = { version = "0.20.0-alpha3", optional = true }
 wio = "0.2"
+raw-window-handle = "0.1"
 
 # This forces docs.rs to build the crate on windows, otherwise the build fails
 # and we get no docs at all.

src/backend/dx11/src/lib.rs

@@ -12,8 +12,6 @@ extern crate smallvec;
 extern crate spirv_cross;
 #[macro_use]
 extern crate winapi;
-#[cfg(feature = "winit")]
-extern crate winit;
 extern crate wio;
 
 use hal::{
@@ -150,10 +148,16 @@ impl Instance {
         }
     }
 
-    #[cfg(feature = "winit")]
-    pub fn create_surface(&self, window: &winit::window::Window) -> Surface {
-        use winit::platform::windows::WindowExtWindows;
-        self.create_surface_from_hwnd(window.hwnd() as *mut _)
+    pub fn create_surface(
+        &self,
+        has_handle: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
+        match has_handle.raw_window_handle() {
+            raw_window_handle::RawWindowHandle::Windows(handle) => {
+                Ok(self.create_surface_from_hwnd(handle.hwnd))
+            }
+            _ => Err(hal::window::InitError::UnsupportedWindowHandle),
+        }
     }
 }
 

src/backend/dx12/Cargo.toml

@@ -27,7 +27,7 @@ log = { version = "0.4" }
 smallvec = "0.6"
 spirv_cross = { version = "0.16", features = ["hlsl"] }
 winapi = { version = "0.3", features = ["basetsd","d3d12","d3d12sdklayers","d3d12shader","d3dcommon","d3dcompiler","dxgi1_2","dxgi1_3","dxgi1_4","dxgi1_6","dxgidebug","dxgiformat","dxgitype","handleapi","minwindef","synchapi","unknwnbase","winbase","windef","winerror","winnt","winuser"] }
-winit = { version = "0.20.0-alpha3", optional = true }
+raw-window-handle = "0.1"
 
 # This forces docs.rs to build the crate on windows, otherwise the build fails
 # and we get no docs at all.

src/backend/dx12/src/lib.rs

@@ -9,8 +9,6 @@ extern crate log;
 extern crate smallvec;
 extern crate spirv_cross;
 extern crate winapi;
-#[cfg(feature = "winit")]
-extern crate winit;
 
 mod command;
 mod conv;

src/backend/dx12/src/window.rs

@@ -1,17 +1,14 @@
 use std::collections::VecDeque;
 use std::{fmt, mem};
 
-#[cfg(feature = "winit")]
-use winit;
-
 use winapi::shared::{
     dxgi1_4,
     windef::{HWND, RECT},
     winerror,
 };
 use winapi::um::winuser::GetClientRect;
 
-use hal::{device::Device as _, format as f, image as i, window as w};
+use hal::{self, device::Device as _, format as f, image as i, window as w};
 use {conv, native, resource as r, Backend, Device, Instance, PhysicalDevice, QueueFamily};
 
 use std::os::raw::c_void;
@@ -25,10 +22,16 @@ impl Instance {
         }
     }
 
-    #[cfg(feature = "winit")]
-    pub fn create_surface(&self, window: &winit::window::Window) -> Surface {
-        use winit::platform::windows::WindowExtWindows;
-        self.create_surface_from_hwnd(window.hwnd() as *mut _)
+    pub fn create_surface(
+        &self,
+        has_handle: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
+        match has_handle.raw_window_handle() {
+            raw_window_handle::RawWindowHandle::Windows(handle) => {
+                Ok(self.create_surface_from_hwnd(handle.hwnd))
+            }
+            _ => Err(hal::window::InitError::UnsupportedWindowHandle),
+        }
     }
 }
 

src/backend/empty/Cargo.toml

@@ -13,4 +13,4 @@ name = "gfx_backend_empty"
 
 [dependencies]
 gfx-hal = { path = "../../hal", version = "0.3" }
-winit = { version = "0.20.0-alpha3", optional = true }
+raw-window-handle = "0.1"

src/backend/empty/src/lib.rs

@@ -2,8 +2,6 @@
 //! outside of the graphics development environment.
 
 extern crate gfx_hal as hal;
-#[cfg(feature = "winit")]
-extern crate winit;
 
 use hal::range::RangeArg;
 use hal::{
@@ -1004,8 +1002,10 @@ impl Instance {
         Ok(Instance)
     }
 
-    #[cfg(feature = "winit")]
-    pub fn create_surface(&self, _: &winit::window::Window) -> Surface {
+    pub fn create_surface(
+        &self,
+        _: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
         unimplemented!()
     }
 }

src/backend/gl/Cargo.toml

@@ -18,7 +18,7 @@ name = "gfx_backend_gl"
 
 [features]
 default = []
-wgl = []
+wgl = ["raw-window-handle"]
 
 [dependencies]
 arrayvec = "0.4"
@@ -31,10 +31,10 @@ glow = "0.2.3"
 parking_lot = "0.9"
 spirv_cross = { version = "0.16", features = ["glsl"] }
 lazy_static = "1"
+raw-window-handle = { version = "0.1", optional = true }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
 glutin = { version = "0.22.0-alpha3", optional = true }
-winit = { version = "0.20.0-alpha3", optional = true }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 js-sys = "0.3.6"

src/backend/gl/src/window/wgl.rs

@@ -30,9 +30,6 @@ pub mod wgl_ext_sys {
 #[link(name = "opengl32")]
 extern "C" {}
 
-#[cfg(feature = "winit")]
-use winit;
-
 pub(crate) struct Entry {
     hwnd: HWND,
     pub(crate) hdc: HDC,
@@ -186,12 +183,17 @@ impl Instance {
         }
     }
 
-    #[cfg(feature = "winit")]
-    pub fn create_surface(&self, window: &winit::window::Window) -> Surface {
-        use winit::platform::windows::WindowExtWindows;
-
-        let hwnd = window.hwnd();
-        self.create_surface_from_hwnd(hwnd as *mut _)
+    pub fn create_surface(
+        &self,
+        has_handle: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
+        match has_handle.raw_window_handle() {
+            #[cfg(windows)]
+            raw_window_handle::RawWindowHandle::Windows(handle) => {
+                Ok(self.create_surface_from_hwnd(handle.hwnd))
+            }
+            _ => Err(hal::window::InitError::UnsupportedWindowHandle),
+        }
     }
 }
 

src/backend/metal/Cargo.toml

@@ -28,7 +28,6 @@ arrayvec = "0.4"
 bitflags = "1.0"
 copyless = "0.1.4"
 log = { version = "0.4" }
-winit = { version = "0.20.0-alpha3", optional = true }
 dispatch = { version = "0.1", optional = true }
 metal = { version = "0.17", features = ["private"] }
 foreign-types = "0.3"
@@ -41,6 +40,7 @@ spirv_cross = { version = "0.16", features = ["msl"] }
 parking_lot = "0.9"
 storage-map = "0.2"
 lazy_static = "1"
+raw-window-handle = "0.1"
 
 # This forces docs.rs to build the crate on mac, otherwise the build fails
 # and we get no docs at all.

src/backend/metal/src/lib.rs

@@ -77,8 +77,6 @@ use objc::{
     runtime::{Object, BOOL, YES, Sel, Class}
 };
 use parking_lot::{Condvar, Mutex};
-#[cfg(feature = "winit")]
-use winit;
 use lazy_static::lazy_static;
 
 use std::mem;
@@ -305,17 +303,20 @@ impl Instance {
         })
     }
 
-    #[cfg(feature = "winit")]
-    pub fn create_surface(&self, window: &winit::window::Window) -> Surface {
-        #[cfg(target_os = "ios")]
-        {
-            use winit::platform::ios::WindowExtIOS;
-            self.create_surface_from_uiview(window.ui_view(), false)
-        }
-        #[cfg(target_os = "macos")]
-        {
-            use winit::platform::macos::WindowExtMacOS;
-            self.create_surface_from_nsview(window.ns_view(), false)
+    pub fn create_surface(
+        &self,
+        has_handle: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
+        match has_handle.raw_window_handle() {
+            #[cfg(target_os = "ios")]
+            raw_window_handle::RawWindowHandle::IOS(handle) => {
+                Ok(self.create_surface_from_uiview(handle.ui_view, false))
+            }
+            #[cfg(target_os = "macos")]
+            raw_window_handle::RawWindowHandle::MacOS(handle) => {
+                Ok(self.create_surface_from_nsview(handle.ns_view, false))
+            }
+            _ => Err(hal::window::InitError::UnsupportedWindowHandle),
         }
     }
 

src/backend/vulkan/Cargo.toml

@@ -28,7 +28,7 @@ shared_library = { version = "0.1.9", optional = true }
 ash = "0.29.0"
 hal = { path = "../../hal", version = "0.3", package = "gfx-hal" }
 smallvec = "0.6"
-winit = { version = "0.20.0-alpha3", optional = true }
+raw-window-handle = "0.1"
 
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3", features = ["libloaderapi", "windef", "winuser"] }

src/backend/vulkan/src/window.rs

@@ -313,53 +313,52 @@ impl Instance {
         self.create_surface_from_vk_surface_khr(surface)
     }
 
-    #[cfg(feature = "winit")]
-    #[allow(unreachable_code)]
-    pub fn create_surface(&self, window: &winit::window::Window) -> Surface {
-        #[cfg(all(unix, not(target_os = "android"), not(target_os = "macos")))]
-        {
-            use winit::platform::unix::WindowExtUnix;
-
-            if self.extensions.contains(&khr::WaylandSurface::name()) {
-                if let Some(display) = window.wayland_display() {
-                    let display: *mut c_void = display as *mut _;
-                    let surface: *mut c_void = window.wayland_surface().unwrap() as *mut _;
-                    return self.create_surface_from_wayland(display, surface);
-                }
+    pub fn create_surface(
+        &self,
+        has_handle: &impl raw_window_handle::HasRawWindowHandle,
+    ) -> Result<Surface, hal::window::InitError> {
+        use raw_window_handle::RawWindowHandle;
+
+        match has_handle.raw_window_handle() {
+            #[cfg(all(
+                unix,
+                not(target_os = "android"),
+                not(target_os = "macos")
+            ))]
+            RawWindowHandle::Wayland(handle)
+                if self.extensions.contains(&khr::WaylandSurface::name()) =>
+            {
+                Ok(self.create_surface_from_wayland(handle.display, handle.surface))
             }
-            #[cfg(feature = "x11")]
-            {
-                if self.extensions.contains(&khr::XlibSurface::name()) {
-                    if let Some(display) = window.xlib_display() {
-                        let window = window.xlib_window().unwrap();
-                        return self.create_surface_from_xlib(display as _, window);
-                    }
-                }
-            }
-            panic!("The Vulkan driver does not support surface creation!");
-        }
-        #[cfg(target_os = "android")]
-        {
-            use winit::platform::android::WindowExtAndroid;
-            return self.create_surface_android(window.get_native_window());
-        }
-        #[cfg(windows)]
-        {
-            use winapi::um::libloaderapi::GetModuleHandleW;
-            use winit::platform::windows::WindowExtWindows;
-
-            let hinstance = unsafe { GetModuleHandleW(ptr::null()) };
-            let hwnd = window.hwnd();
-            return self.create_surface_from_hwnd(hinstance as *mut _, hwnd as *mut _);
-        }
-        #[cfg(target_os = "macos")]
-        {
-            use winit::platform::macos::WindowExtMacOS;
-
-            return self.create_surface_from_ns_view(window.ns_view());
+            #[cfg(all(
+                feature = "x11",
+                unix,
+                not(target_os = "android"),
+                not(target_os = "macos")
+            ))]
+            RawWindowHandle::X11(handle)
+                if self.extensions.contains(&khr::XlibSurface::name()) =>
+            {
+                Ok(self.create_surface_from_xlib(handle.display as *mut _, handle.window))
+            }
+            // #[cfg(target_os = "android")]
+            // RawWindowHandle::ANativeWindowHandle(handle) => {
+            //     let native_window = unimplemented!();
+            //     self.create_surface_android(native_window)
+            //}
+            #[cfg(windows)]
+            RawWindowHandle::Windows(handle) => {
+                use winapi::um::libloaderapi::GetModuleHandleW;
+
+                let hinstance = unsafe { GetModuleHandleW(ptr::null()) };
+                Ok(self.create_surface_from_hwnd(hinstance as *mut _, handle.hwnd))
+            }
+            #[cfg(target_os = "macos")]
+            RawWindowHandle::MacOS(handle) => {
+                Ok(self.create_surface_from_ns_view(handle.ns_view))
+            }
+            _ => Err(hal::window::InitError::UnsupportedWindowHandle),
         }
-        let _ = window;
-        panic!("No suitable WSI enabled!");
     }
 
     pub fn create_surface_from_vk_surface_khr(&self, surface: vk::SurfaceKHR) -> Surface {