Skip to main content

Window

Struct Window 

Source
pub struct Window { /* private fields */ }
Expand description

Managed window handle.

Things like redrawing a window, accepting a user interaction, are passed by window events. A graphical program runs an event loop to poll these events and handles them. The window subsystem mediates the interaction between the event loop and async task process. When a window event happens, it will need to locate the window to deliver the window event. This is impossible without getting the windows managed.

Therefore, we need such an object. It’s built on the top of an winit::window::Window, registered to the window subsystem and expose a subscriber window_event_sub for receiving window events dedicated to this window.

Implementations§

Source§

impl Window

Source

pub fn set_refreshing(&mut self, enable: bool)

Set the window as being refreshing or not.

By setting this window as being refreshing, every time the event loop is about to sleep, a redraw event is going to be queued for this window. This is required for video applications and games.

Source

pub fn is_refreshing(&self) -> bool

Check if the window is refreshing or not.

Source

pub fn window_event_sub(&self) -> Sub<WindowEvent>

Obtain the window event subscriber dedicated to this window.

Trait Implementations§

Source§

impl AccessWinitWindow for Window

Source§

fn map_winit_window<F, T>(&self, f: F) -> T
where F: FnOnce(&Box<dyn WinitWindow>) -> T,

Manipulate the underlying winit::window::Window in an immutable manner.
Source§

fn map_winit_window_mut<F, T>(&mut self, f: F) -> T
where F: FnOnce(&mut Box<dyn WinitWindow>) -> T,

Manipulate the underlying winit::window::Window in a mutable manner.
Source§

impl Drop for Window

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Window

§

impl !Send for Window

§

impl !Sync for Window

§

impl !UnwindSafe for Window

§

impl Freeze for Window

§

impl Unpin for Window

§

impl UnsafeUnpin for Window

Blanket Implementations§

Source§

impl<T> AccessWinitWindowExt for T

Source§

fn id(&self) -> WindowId

Source§

fn scale_factor(&self) -> f64

Source§

fn pre_present_notify(&self)

Source§

fn surface_position(&self) -> PhysicalPosition<i32>

Source§

fn outer_position(&self) -> Result<PhysicalPosition<i32>, RequestError>

Source§

fn set_outer_position(&self, position: Position)

Source§

fn surface_size(&self) -> PhysicalSize<u32>

Source§

fn request_surface_size(&self, size: Size) -> Option<PhysicalSize<u32>>

Source§

fn outer_size(&self) -> PhysicalSize<u32>

Source§

fn safe_area(&self) -> PhysicalInsets<u32>

Source§

fn set_min_surface_size(&self, min_size: Option<Size>)

Source§

fn set_max_surface_size(&self, min_size: Option<Size>)

Source§

fn surface_resize_increments(&self) -> Option<PhysicalSize<u32>>

Source§

fn set_surface_resize_increments(&self, increments: Option<Size>)

Source§

fn title(&self) -> String

Source§

fn set_title(&self, title: &str)

Source§

fn set_transparent(&self, transparent: bool)

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

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

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

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

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

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.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more