Struct slint::platform::software_renderer::MinimalSoftwareWindow
pub struct MinimalSoftwareWindow { /* private fields */ }
Expand description
This is a minimal adapter for a Window that doesn’t have any other feature than rendering using the software renderer.
Implementations§
§impl MinimalSoftwareWindow
impl MinimalSoftwareWindow
pub fn new(repaint_buffer_type: RepaintBufferType) -> Rc<MinimalSoftwareWindow>
pub fn new(repaint_buffer_type: RepaintBufferType) -> Rc<MinimalSoftwareWindow>
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
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.
Methods from Deref<Target = Window>§
pub fn show(&self) -> Result<(), PlatformError>
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>
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>
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
)
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)
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
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
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>)
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
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>)
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
pub fn is_fullscreen(&self) -> bool
Returns if the window is currently fullscreen
pub fn set_fullscreen(&self, fullscreen: bool)
pub fn set_fullscreen(&self, fullscreen: bool)
Set or unset the window to display fullscreen.
pub fn is_maximized(&self) -> bool
pub fn is_maximized(&self) -> bool
Returns if the window is currently maximized
pub fn set_maximized(&self, maximized: bool)
pub fn set_maximized(&self, maximized: bool)
Maximize or unmaximize the window.
pub fn is_minimized(&self) -> bool
pub fn is_minimized(&self) -> bool
Returns if the window is currently minimized
pub fn set_minimized(&self, minimized: bool)
pub fn set_minimized(&self, minimized: bool)
Minimize or unminimze the window.
pub fn dispatch_event(&self, event: WindowEvent)
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
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
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
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.
Trait Implementations§
§impl Deref for MinimalSoftwareWindow
impl Deref for MinimalSoftwareWindow
§impl WindowAdapter for MinimalSoftwareWindow
impl WindowAdapter for MinimalSoftwareWindow
§fn size(&self) -> PhysicalSize
fn size(&self) -> PhysicalSize
§fn set_size(&self, size: WindowSize)
fn set_size(&self, size: WindowSize)
§fn request_redraw(&self)
fn request_redraw(&self)
§fn set_visible(&self, _visible: bool) -> Result<(), PlatformError>
fn set_visible(&self, _visible: bool) -> Result<(), PlatformError>
§fn position(&self) -> Option<PhysicalPosition>
fn position(&self) -> Option<PhysicalPosition>
§fn set_position(&self, _position: WindowPosition)
fn set_position(&self, _position: WindowPosition)
§fn update_window_properties(&self, _properties: WindowProperties<'_>)
fn update_window_properties(&self, _properties: WindowProperties<'_>)
§fn window_handle_06(&self) -> Result<WindowHandle<'_>, HandleError>
fn window_handle_06(&self) -> Result<WindowHandle<'_>, HandleError>
§fn display_handle_06(&self) -> Result<DisplayHandle<'_>, HandleError>
fn display_handle_06(&self) -> Result<DisplayHandle<'_>, HandleError>
Auto Trait Implementations§
impl !Freeze for MinimalSoftwareWindow
impl !RefUnwindSafe for MinimalSoftwareWindow
impl !Send for MinimalSoftwareWindow
impl !Sync for MinimalSoftwareWindow
impl Unpin for MinimalSoftwareWindow
impl !UnwindSafe for MinimalSoftwareWindow
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more