// Copyright © SixtyFPS GmbH // SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-Slint-Royalty-free-1.1 OR LicenseRef-Slint-commercial #![doc = include_str!("README.md")] #![doc(html_logo_url = "https://slint.dev/logo/slint-logo-square-light.svg")] extern crate alloc; use event_loop::CustomEvent; use i_slint_core::platform::EventLoopProxy; use i_slint_core::window::WindowAdapter; use renderer::WinitCompatibleRenderer; use std::rc::Rc; mod winitwindowadapter; use i_slint_core::platform::PlatformError; use winitwindowadapter::*; pub(crate) mod event_loop; /// Re-export of the winit crate. pub use winit; /// Internal type used by the winit backend for thread communication and window system updates. #[non_exhaustive] #[derive(Debug)] pub enum SlintUserEvent { CustomEvent { event: CustomEvent }, } mod renderer { use i_slint_core::platform::PlatformError; pub trait WinitCompatibleRenderer { fn render(&self, window: &i_slint_core::api::Window) -> Result<(), PlatformError>; fn as_core_renderer(&self) -> &dyn i_slint_core::renderer::Renderer; // Got WindowEvent::Occluded fn occluded(&self, _: bool) {} // Got winit::Event::Resumed fn resumed(&self, _winit_window: &winit::window::Window) -> Result<(), PlatformError> { Ok(()) } } #[cfg(feature = "renderer-femtovg")] pub(crate) mod femtovg; #[cfg(enable_skia_renderer)] pub(crate) mod skia; #[cfg(feature = "renderer-software")] pub(crate) mod sw; } #[cfg(enable_accesskit)] mod accesskit; #[cfg(target_arch = "wasm32")] pub(crate) mod wasm_input_helper; #[cfg(all(target_arch = "wasm32", feature = "renderer-femtovg"))] pub fn create_gl_window_with_canvas_id( canvas_id: &str, ) -> Result, PlatformError> { let builder = WinitWindowAdapter::window_builder(canvas_id)?; let (renderer, window) = renderer::femtovg::GlutinFemtoVGRenderer::new(builder)?; let adapter = WinitWindowAdapter::new(renderer, window); Ok(adapter) } cfg_if::cfg_if! { if #[cfg(feature = "renderer-femtovg")] { const DEFAULT_RENDERER_NAME: &str = "FemtoVG"; } else if #[cfg(enable_skia_renderer)] { const DEFAULT_RENDERER_NAME: &'static str = "Skia"; } else if #[cfg(feature = "renderer-software")] { const DEFAULT_RENDERER_NAME: &'static str = "Software"; } else { compile_error!("Please select a feature to build with the winit backend: `renderer-femtovg`, `renderer-skia`, `renderer-skia-opengl`, `renderer-skia-vulkan` or `renderer-software`"); } } fn default_renderer_factory( window_builder: winit::window::WindowBuilder, ) -> Result<(Box, Rc), PlatformError> { cfg_if::cfg_if! { if #[cfg(feature = "renderer-femtovg")] { renderer::femtovg::GlutinFemtoVGRenderer::new(window_builder) } else if #[cfg(enable_skia_renderer)] { renderer::skia::WinitSkiaRenderer::new(window_builder) } else if #[cfg(feature = "renderer-software")] { renderer::sw::WinitSoftwareRenderer::new(window_builder) } else { compile_error!("Please select a feature to build with the winit backend: `renderer-femtovg`, `renderer-skia`, `renderer-skia-opengl`, `renderer-skia-vulkan` or `renderer-software`"); } } } fn try_create_window_with_fallback_renderer( builder: winit::window::WindowBuilder, ) -> Option> { [ #[cfg(any( feature = "renderer-skia", feature = "renderer-skia-opengl", feature = "renderer-skia-vulkan" ))] renderer::skia::WinitSkiaRenderer::new, #[cfg(feature = "renderer-femtovg")] renderer::femtovg::GlutinFemtoVGRenderer::new, #[cfg(feature = "renderer-software")] renderer::sw::WinitSoftwareRenderer::new, ] .into_iter() .find_map(|renderer_factory| { let (renderer, winit_window) = renderer_factory(builder.clone()).ok()?; Some(WinitWindowAdapter::new(renderer, winit_window)) }) } #[doc(hidden)] pub type NativeWidgets = (); #[doc(hidden)] pub type NativeGlobals = (); #[doc(hidden)] pub const HAS_NATIVE_STYLE: bool = false; #[doc(hidden)] pub mod native_widgets {} #[doc = concat!("This struct implements the Slint Platform trait. Use this in conjunction with [`slint::platform::set_platform`](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/rust/slint/platform/fn.set_platform.html) to initialize.")] /// Slint to use winit for all windowing system interaction. /// /// ```rust,no_run /// use i_slint_backend_winit::Backend; /// slint::platform::set_platform(Box::new(Backend::new().unwrap())); /// ``` pub struct Backend { renderer_factory_fn: fn( window_builder: winit::window::WindowBuilder, ) -> Result<(Box, Rc), PlatformError>, event_loop_state: std::cell::RefCell>, /// This hook is called before a Window is created. /// /// It can be used to adjust settings of window that will be created /// /// # Example /// /// ```rust,no_run /// let mut backend = i_slint_backend_winit::Backend::new().unwrap(); /// backend.window_builder_hook = Some(Box::new(|builder| builder.with_content_protected(true))); /// slint::platform::set_platform(Box::new(backend)); /// ``` pub window_builder_hook: Option winit::window::WindowBuilder>>, } impl Backend { #[doc = concat!("Creates a new winit backend with the default renderer that's compiled in. See the [backend documentation](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/rust/slint/index.html#backends) for")] /// details on how to select the default renderer. pub fn new() -> Result { Self::new_with_renderer_by_name(None) } #[doc = concat!("Creates a new winit backend with the renderer specified by name. See the [backend documentation](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/rust/slint/index.html#backends) for")] /// details on how to select the default renderer. /// If the renderer name is `None` or the name is not recognized, the default renderer is selected. pub fn new_with_renderer_by_name(renderer_name: Option<&str>) -> Result { // Initialize the winit event loop and propagate errors if for example `DISPLAY` or `WAYLAND_DISPLAY` isn't set. crate::event_loop::with_window_target(|_| Ok(()))?; let renderer_factory_fn = match renderer_name { #[cfg(feature = "renderer-femtovg")] Some("gl") | Some("femtovg") => renderer::femtovg::GlutinFemtoVGRenderer::new, #[cfg(enable_skia_renderer)] Some("skia") => renderer::skia::WinitSkiaRenderer::new, #[cfg(enable_skia_renderer)] Some("skia-opengl") => renderer::skia::WinitSkiaRenderer::new_opengl, #[cfg(all(enable_skia_renderer, not(target_os = "android")))] Some("skia-software") => renderer::skia::WinitSkiaRenderer::new_software, #[cfg(feature = "renderer-software")] Some("sw") | Some("software") => renderer::sw::WinitSoftwareRenderer::new, None => default_renderer_factory, Some(renderer_name) => { eprintln!( "slint winit: unrecognized renderer {}, falling back to {}", renderer_name, DEFAULT_RENDERER_NAME ); default_renderer_factory } }; Ok(Self { renderer_factory_fn, event_loop_state: Default::default(), window_builder_hook: None, }) } } fn send_event_via_global_event_loop_proxy( event: SlintUserEvent, ) -> Result<(), i_slint_core::api::EventLoopError> { #[cfg(not(target_arch = "wasm32"))] crate::event_loop::GLOBAL_PROXY .get_or_init(Default::default) .lock() .unwrap() .send_event(event)?; #[cfg(target_arch = "wasm32")] { crate::event_loop::GLOBAL_PROXY.with(|global_proxy| { let mut maybe_proxy = global_proxy.borrow_mut(); let proxy = maybe_proxy.get_or_insert_with(Default::default); // Calling send_event is usually done by winit at the bottom of the stack, // in event handlers, and thus winit might decide to process the event // immediately within that stack. // To prevent re-entrancy issues that might happen by getting the application // event processed on top of the current stack, set winit in Poll mode so that // events are queued and process on top of a clean stack during a requested animation // frame a few moments later. // This also allows batching multiple post_event calls and redraw their state changes // all at once. proxy.send_event(SlintUserEvent::CustomEvent { event: CustomEvent::WakeEventLoopWorkaround, })?; proxy.send_event(event)?; Ok(()) })? } Ok(()) } impl i_slint_core::platform::Platform for Backend { fn create_window_adapter(&self) -> Result, PlatformError> { let mut builder = WinitWindowAdapter::window_builder( #[cfg(target_arch = "wasm32")] "canvas".into(), )?; if let Some(hook) = &self.window_builder_hook { builder = hook(builder); } let adapter = (self.renderer_factory_fn)(builder.clone()) .map(|(renderer, window)| WinitWindowAdapter::new(renderer, window)) .or_else(|e| { try_create_window_with_fallback_renderer(builder) .ok_or_else(|| format!("Winit backend failed to find a suitable renderer: {e}")) })?; Ok(adapter) } fn run_event_loop(&self) -> Result<(), PlatformError> { let loop_state = self.event_loop_state.borrow_mut().take().unwrap_or_default(); let new_state = loop_state.run()?; *self.event_loop_state.borrow_mut() = Some(new_state); Ok(()) } #[cfg(not(target_arch = "wasm32"))] fn process_events( &self, timeout: core::time::Duration, _: i_slint_core::InternalToken, ) -> Result, PlatformError> { let loop_state = self.event_loop_state.borrow_mut().take().unwrap_or_default(); let (new_state, status) = loop_state.pump_events(Some(timeout))?; *self.event_loop_state.borrow_mut() = Some(new_state); match status { winit::platform::pump_events::PumpStatus::Continue => { Ok(core::ops::ControlFlow::Continue(())) } winit::platform::pump_events::PumpStatus::Exit(code) => { if code == 0 { Ok(core::ops::ControlFlow::Break(())) } else { Err(format!("Event loop exited with non-zero code {code}").into()) } } } } fn new_event_loop_proxy(&self) -> Option> { struct Proxy; impl EventLoopProxy for Proxy { fn quit_event_loop(&self) -> Result<(), i_slint_core::api::EventLoopError> { send_event_via_global_event_loop_proxy(SlintUserEvent::CustomEvent { event: CustomEvent::Exit, }) } fn invoke_from_event_loop( &self, event: Box, ) -> Result<(), i_slint_core::api::EventLoopError> { let e = SlintUserEvent::CustomEvent { event: CustomEvent::UserEvent(event) }; send_event_via_global_event_loop_proxy(e) } } Some(Box::new(Proxy)) } #[cfg(target_arch = "wasm32")] fn set_clipboard_text(&self, text: &str, clipboard: i_slint_core::platform::Clipboard) { crate::wasm_input_helper::set_clipboard_text(text.into(), clipboard); } #[cfg(not(target_arch = "wasm32"))] fn set_clipboard_text(&self, text: &str, clipboard: i_slint_core::platform::Clipboard) { crate::event_loop::with_window_target(|event_loop_target| { if let Some(mut clipboard) = event_loop_target.clipboard(clipboard) { clipboard.set_contents(text.into()).ok(); } Ok(()) }) .ok(); } #[cfg(target_arch = "wasm32")] fn clipboard_text(&self, clipboard: i_slint_core::platform::Clipboard) -> Option { crate::wasm_input_helper::get_clipboard_text(clipboard) } #[cfg(not(target_arch = "wasm32"))] fn clipboard_text(&self, clipboard: i_slint_core::platform::Clipboard) -> Option { crate::event_loop::with_window_target(|event_loop_target| { Ok(event_loop_target .clipboard(clipboard) .and_then(|mut clipboard| clipboard.get_contents().ok())) }) .ok() .flatten() } } /// Spawn the event loop, using [`winit::platform::web::EventLoopExtWebSys::spawn()`] #[cfg(target_arch = "wasm32")] pub fn spawn_event_loop() -> Result<(), PlatformError> { crate::event_loop::spawn() } /// Invokes the specified callback with a reference to the [`winit::event_loop::EventLoopWindowTarget`]. /// Use this to get access to the display connection or create new windows with [`winit::window::WindowBuilder`]. /// /// *Note*: This function can only be called from within the Slint main thread. pub fn with_event_loop_window_target( callback: impl FnOnce( &winit::event_loop::EventLoopWindowTarget, ) -> Result>, ) -> Result> { crate::event_loop::with_window_target(|event_loop_interface| { callback(event_loop_interface.event_loop_target()) }) } mod private { pub trait WinitWindowAccessorSealed {} } #[doc = concat!("This helper trait can be used to obtain access to the [`winit::window::Window`] for a given [`slint::Window`](https://slint.dev/releases/", env!("CARGO_PKG_VERSION"), "/docs/rust/slint/struct.window).")] pub trait WinitWindowAccessor: private::WinitWindowAccessorSealed { /// Returns true if a [`winit::window::Window`] exists for this window. This is the case if the window is /// backed by this winit backend. fn has_winit_window(&self) -> bool; /// Invokes the specified callback with a reference to the [`winit::window::Window`] that exists for this Slint window /// and returns `Some(T)`; otherwise `None`. fn with_winit_window(&self, callback: impl FnOnce(&winit::window::Window) -> T) -> Option; } impl WinitWindowAccessor for i_slint_core::api::Window { fn has_winit_window(&self) -> bool { winit_window_rc_for_window(self).is_some() } fn with_winit_window( &self, callback: impl FnOnce(&winit::window::Window) -> T, ) -> Option { winit_window_rc_for_window(self).as_ref().map(|w| callback(w)) } } impl private::WinitWindowAccessorSealed for i_slint_core::api::Window {} fn winit_window_rc_for_window( window: &i_slint_core::api::Window, ) -> Option> { i_slint_core::window::WindowInner::from_pub(window) .window_adapter() .internal(i_slint_core::InternalToken) .and_then(|wa| wa.as_any().downcast_ref::()) .map(|adapter| adapter.winit_window()) } #[cfg(test)] mod testui { slint::slint! { export component App inherits Window { Text { text: "Ok"; } } } } // Sorry, can't test with rust test harness and multiple threads. #[cfg(not(any(target_arch = "wasm32", target_os = "macos", target_os = "ios")))] #[test] fn test_window_accessor_and_rwh() { slint::platform::set_platform(Box::new(crate::Backend::new().unwrap())).unwrap(); use testui::*; let app = App::new().unwrap(); let slint_window = app.window(); assert!(slint_window.has_winit_window()); let handle = slint_window.window_handle(); use raw_window_handle_06::{HasDisplayHandle, HasWindowHandle}; assert!(handle.window_handle().is_ok()); assert!(handle.display_handle().is_ok()); }