Struct slint_interpreter::Window

pub struct Window(/* private fields */);

This type represents a window towards the windowing system, that’s used to render the scene of a component. It provides API to control windowing system specific aspects such as the position on the screen.

Implementations

impl Window

pub fn new(window_adapter_weak: Weak<dyn WindowAdapter>) -> Window

Create a new window from a window adapter

You only need to create the window yourself when you create a [WindowAdapter] from Platform::create_window_adapter

Since the window adapter must own the Window, this function is meant to be used with Rc::new_cyclic

Example

use std::rc::Rc;
use slint::platform::{WindowAdapter, Renderer};
use slint::{Window, PhysicalSize};
struct MyWindowAdapter {
    window: Window,
    //...
}
impl WindowAdapter for MyWindowAdapter {
   fn window(&self) -> &Window { &self.window }
   fn size(&self) -> PhysicalSize { unimplemented!() }
   fn renderer(&self) -> &dyn Renderer { unimplemented!() }
}

fn create_window_adapter() -> Rc<dyn WindowAdapter> {
   Rc::<MyWindowAdapter>::new_cyclic(|weak| {
       MyWindowAdapter {
          window: Window::new(weak.clone()),
          //...
       }
   })
}

pub fn show(&self) -> Result<(), PlatformError>

Shows the window on the screen. An additional strong reference on the associated component is maintained while the window is visible.

Call Self::hide() to make the window invisible again, and drop the additional strong reference.

pub fn hide(&self) -> Result<(), PlatformError>

Hides the window, so that it is not visible anymore. The additional strong reference on the associated component, that was created when Self::show() was called, is dropped.

pub fn set_rendering_notifier( &self, callback: impl FnMut(RenderingState, &GraphicsAPI<'_>) + 'static, ) -> Result<(), SetRenderingNotifierError>

This function allows registering a callback that’s invoked during the different phases of rendering. This allows custom rendering on top or below of the scene.

pub fn on_close_requested( &self, callback: impl FnMut() -> CloseRequestResponse + 'static, )

This function allows registering a callback that’s invoked when the user tries to close a window. The callback has to return a CloseRequestResponse.

pub fn request_redraw(&self)

This function issues a request to the windowing system to redraw the contents of the window.

pub fn scale_factor(&self) -> f32

This function returns the scale factor that allows converting between logical and physical pixels.

pub fn position(&self) -> PhysicalPosition

Returns the position of the window on the screen, in physical screen coordinates and including a window frame (if present).

pub fn set_position(&self, position: impl Into<WindowPosition>)

Sets the position of the window on the screen, in physical screen coordinates and including a window frame (if present). Note that on some windowing systems, such as Wayland, this functionality is not available.

pub fn size(&self) -> PhysicalSize

Returns the size of the window on the screen, in physical screen coordinates and excluding a window frame (if present).

pub fn set_size(&self, size: impl Into<WindowSize>)

Resizes the window to the specified size on the screen, in physical pixels and excluding a window frame (if present).

pub fn is_fullscreen(&self) -> bool

Returns if the window is currently fullscreen

pub fn set_fullscreen(&self, fullscreen: bool)

Set or unset the window to display fullscreen.

pub fn is_maximized(&self) -> bool

Returns if the window is currently maximized

pub fn set_maximized(&self, maximized: bool)

Maximize or unmaximize the window.

pub fn is_minimized(&self) -> bool

Returns if the window is currently minimized

pub fn set_minimized(&self, minimized: bool)

Minimize or unminimze the window.

pub fn dispatch_event(&self, event: WindowEvent)

Dispatch a window event to the scene.

Use this when you’re implementing your own backend and want to forward user input events.

Any position fields in the event must be in the logical pixel coordinate system relative to the top left corner of the window.

pub fn has_active_animations(&self) -> bool

Returns true if there is an animation currently active on any property in the Window; false otherwise.

pub fn is_visible(&self) -> bool

Returns the visibility state of the window. This function can return false even if you previously called show() on it, for example if the user minimized the window.

pub fn window_handle(&self) -> WindowHandle

Returns a struct that implements the raw window handle traits to access the windowing system specific window and display handles. This function is only accessible if you enable the raw-window-handle-06 crate feature.

pub fn take_snapshot( &self, ) -> Result<SharedPixelBuffer<Rgba<u8>>, PlatformError>

Takes a snapshot of the window contents and returns it as RGBA8 encoded pixel buffer.

Note that this function may be slow to call. Reading from the framebuffer previously rendered, too, may take a long time.

Trait Implementations

impl WinitWindowAccessor for Window

fn has_winit_window(&self) -> bool

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 with_winit_window<T>(&self, callback: impl FnOnce(&Window) -> T) -> Option<T>

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 on_winit_window_event( &self, callback: impl FnMut(&Window, &WindowEvent) -> WinitWindowEventResult + 'static, )

Registers a window event filter callback for this Slint window.