#![allow(unsafe_code)] use alloc::sync::Arc; use bevy_ecs::prelude::Component; use core::{any::Any, marker::PhantomData, ops::Deref}; use raw_window_handle::{ DisplayHandle, HandleError, HasDisplayHandle, HasWindowHandle, RawDisplayHandle, RawWindowHandle, WindowHandle, }; use std::sync::Mutex; /// A wrapper over a window. /// /// This allows us to extend the lifetime of the window, so it doesn't get eagerly dropped while a /// pipelined renderer still has frames in flight that need to draw to it. /// /// This is achieved by storing a shared reference to the window in the [`RawHandleWrapper`], /// which gets picked up by the renderer during extraction. #[derive(Debug)] pub struct WindowWrapper { reference: Arc, ty: PhantomData, } impl WindowWrapper { /// Creates a `WindowWrapper` from a window. pub fn new(window: W) -> WindowWrapper { WindowWrapper { reference: Arc::new(window), ty: PhantomData, } } } impl Deref for WindowWrapper { type Target = W; fn deref(&self) -> &Self::Target { self.reference.downcast_ref::().unwrap() } } /// A wrapper over [`RawWindowHandle`] and [`RawDisplayHandle`] that allows us to safely pass it across threads. /// /// Depending on the platform, the underlying pointer-containing handle cannot be used on all threads, /// and so we cannot simply make it (or any type that has a safe operation to get a [`RawWindowHandle`] or [`RawDisplayHandle`]) /// thread-safe. #[derive(Debug, Clone, Component)] pub struct RawHandleWrapper { _window: Arc, /// Raw handle to a window. pub window_handle: RawWindowHandle, /// Raw handle to the display server. pub display_handle: RawDisplayHandle, } impl RawHandleWrapper { /// Creates a `RawHandleWrapper` from a `WindowWrapper`. pub fn new( window: &WindowWrapper, ) -> Result { Ok(RawHandleWrapper { _window: window.reference.clone(), window_handle: window.window_handle()?.as_raw(), display_handle: window.display_handle()?.as_raw(), }) } /// Returns a [`HasWindowHandle`] + [`HasDisplayHandle`] impl, which exposes [`WindowHandle`] and [`DisplayHandle`]. /// /// # Safety /// /// Some platforms have constraints on where/how this handle can be used. For example, some platforms don't support doing window /// operations off of the main thread. The caller must ensure the [`RawHandleWrapper`] is only used in valid contexts. pub unsafe fn get_handle(&self) -> ThreadLockedRawWindowHandleWrapper { ThreadLockedRawWindowHandleWrapper(self.clone()) } } // SAFETY: [`RawHandleWrapper`] is just a normal "raw pointer", which doesn't impl Send/Sync. However the pointer is only // exposed via an unsafe method that forces the user to make a call for a given platform. (ex: some platforms don't // support doing window operations off of the main thread). // A recommendation for this pattern (and more context) is available here: // https://github.com/rust-windowing/raw-window-handle/issues/59 unsafe impl Send for RawHandleWrapper {} // SAFETY: This is safe for the same reasons as the Send impl above. unsafe impl Sync for RawHandleWrapper {} /// A [`RawHandleWrapper`] that cannot be sent across threads. /// /// This safely exposes [`RawWindowHandle`] and [`RawDisplayHandle`], but care must be taken to ensure that the construction itself is correct. /// /// This can only be constructed via the [`RawHandleWrapper::get_handle()`] method; /// be sure to read the safety docs there about platform-specific limitations. /// In many cases, this should only be constructed on the main thread. pub struct ThreadLockedRawWindowHandleWrapper(RawHandleWrapper); impl HasWindowHandle for ThreadLockedRawWindowHandleWrapper { fn window_handle(&self) -> Result { // SAFETY: the caller has validated that this is a valid context to get [`RawHandleWrapper`] // as otherwise an instance of this type could not have been constructed // NOTE: we cannot simply impl HasRawWindowHandle for RawHandleWrapper, // as the `raw_window_handle` method is safe. We cannot guarantee that all calls // of this method are correct (as it may be off the main thread on an incompatible platform), // and so exposing a safe method to get a [`RawWindowHandle`] directly would be UB. Ok(unsafe { WindowHandle::borrow_raw(self.0.window_handle) }) } } impl HasDisplayHandle for ThreadLockedRawWindowHandleWrapper { fn display_handle(&self) -> Result { // SAFETY: the caller has validated that this is a valid context to get [`RawDisplayHandle`] // as otherwise an instance of this type could not have been constructed // NOTE: we cannot simply impl HasRawDisplayHandle for RawHandleWrapper, // as the `raw_display_handle` method is safe. We cannot guarantee that all calls // of this method are correct (as it may be off the main thread on an incompatible platform), // and so exposing a safe method to get a [`RawDisplayHandle`] directly would be UB. Ok(unsafe { DisplayHandle::borrow_raw(self.0.display_handle) }) } } /// Holder of the [`RawHandleWrapper`] with wrappers, to allow use in asynchronous context #[derive(Debug, Clone, Component)] pub struct RawHandleWrapperHolder(pub Arc>>);