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

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

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>

Registers the window with the windowing system in order to make it visible on the screen.

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

De-registers the window from the windowing system, therefore hiding it.

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 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.

Trait Implementations§

§

impl Deref for MinimalSoftwareWindow

§

type Target = Window

The resulting type after dereferencing.
§

fn deref(&self) -> &<MinimalSoftwareWindow as Deref>::Target

Dereferences the value.
§

impl WindowAdapter for MinimalSoftwareWindow

§

fn window(&self) -> &Window

Returns the window API.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for Twhere T: Any,

§

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert 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 + 'static>

Convert 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)

Convert &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)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.