Struct MinimalSoftwareWindow 

pub struct MinimalSoftwareWindow { /* private fields */ }

This is a minimal adapter for a Window that doesn’t have any other feature than rendering using the software renderer.

Implementations

impl MinimalSoftwareWindow

pub fn new(repaint_buffer_type: RepaintBufferType) -> Rc<Self>

Instantiate a new MinimalWindowAdaptor

The repaint_buffer_type parameter specify what kind of buffer are passed to the SoftwareRenderer

pub fn draw_if_needed( &self, render_callback: impl FnOnce(&SoftwareRenderer), ) -> bool

If the window needs to be redrawn, the callback will be called with the renderer that should be used to do the drawing.

SoftwareRenderer::render() or SoftwareRenderer::render_by_line() should be called in that callback.

Return true if something was redrawn.

pub async fn draw_async_if_needed( &self, render_callback: impl AsyncFnOnce(&SoftwareRenderer), ) -> bool

Available on crate feature experimental only.

If the window needs to be redrawn, the callback will be called with the renderer that should be used to do the drawing.

SoftwareRenderer::render() or SoftwareRenderer::render_by_line() should be called in that callback.

Return true if something was redrawn.

Methods from Deref<Target = Window>

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.

This function panics if there is an error processing the event. Use Self::try_dispatch_event() to handle the error.

pub fn try_dispatch_event( &self, event: WindowEvent, ) -> Result<(), PlatformError>

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 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 as it may need to re-render the scene.

Trait Implementations

impl Deref for MinimalSoftwareWindow

type Target = Window

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl WindowAdapter for MinimalSoftwareWindow

fn window(&self) -> &Window

Returns the window API.

fn renderer(&self) -> &dyn Renderer

Return the renderer.

fn size(&self) -> PhysicalSize

Return the size of the Window on the screen

fn set_size(&self, size: WindowSize)

Request a new size for the window to the specified size on the screen, in physical or logical pixels and excluding a window frame (if present).

fn request_redraw(&self)

Issues a request to the windowing system to re-render the contents of the window.

fn set_visible(&self, _visible: bool) -> Result<(), PlatformError>

Show the window if the argument is true, hide otherwise.

fn position(&self) -> Option<PhysicalPosition>

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

fn set_position(&self, _position: WindowPosition)

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

fn update_window_properties(&self, _properties: WindowProperties<'_>)

Re-implement this function to update the properties such as window title or layout constraints.