Struct winit::platform_impl::linux::wayland::window::Window

source ·
pub struct Window {
    window: Window,
    window_id: WindowId,
    window_state: Arc<Mutex<WindowState>>,
    compositor: Arc<CompositorState>,
    display: WlDisplay,
    xdg_activation: Option<XdgActivationV1>,
    attention_requested: Arc<AtomicBool>,
    queue_handle: QueueHandle<WinitState>,
    window_requests: Arc<WindowRequests>,
    monitors: Arc<Mutex<Vec<MonitorHandle>>>,
    event_loop_awakener: Ping,
    window_events_sink: Arc<Mutex<EventSink>>,
}
Expand description

The Wayland window.

Fields§

§window: Window

Reference to the underlying SCTK window.

§window_id: WindowId

Window id.

§window_state: Arc<Mutex<WindowState>>

The state of the window.

§compositor: Arc<CompositorState>

Compositor to handle WlRegion stuff.

§display: WlDisplay

The wayland display used solely for raw window handle.

§xdg_activation: Option<XdgActivationV1>

Xdg activation to request user attention.

§attention_requested: Arc<AtomicBool>

The state of the requested attention from the xdg_activation.

§queue_handle: QueueHandle<WinitState>

Handle to the main queue to perform requests.

§window_requests: Arc<WindowRequests>

Window requests to the event loop.

§monitors: Arc<Mutex<Vec<MonitorHandle>>>

Observed monitors.

§event_loop_awakener: Ping

Source to wake-up the event-loop for window requests.

§window_events_sink: Arc<Mutex<EventSink>>

The event sink to deliver synthetic events.

Implementations§

source§

impl Window

source

pub(crate) fn new( event_loop_window_target: &ActiveEventLoop, attributes: WindowAttributes, ) -> Result<Self, RootOsError>

source§

impl Window

source

pub fn id(&self) -> WindowId

source

pub fn set_title(&self, title: impl ToString)

source

pub fn set_visible(&self, _visible: bool)

source

pub fn is_visible(&self) -> Option<bool>

source

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

source

pub fn inner_position(&self) -> Result<PhysicalPosition<i32>, NotSupportedError>

source

pub fn set_outer_position(&self, _: Position)

source

pub fn inner_size(&self) -> PhysicalSize<u32>

source

pub fn request_redraw(&self)

source

pub fn pre_present_notify(&self)

source

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

source

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

source

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

Set the minimum inner size for the window.

source

pub fn set_max_inner_size(&self, max_size: Option<Size>)

Set the maximum inner size for the window.

source

pub fn resize_increments(&self) -> Option<PhysicalSize<u32>>

source

pub fn set_resize_increments(&self, _increments: Option<Size>)

source

pub fn set_transparent(&self, transparent: bool)

source

pub fn has_focus(&self) -> bool

source

pub fn is_minimized(&self) -> Option<bool>

source

pub fn show_window_menu(&self, position: Position)

source

pub fn drag_resize_window( &self, direction: ResizeDirection, ) -> Result<(), ExternalError>

source

pub fn set_resizable(&self, resizable: bool)

source

pub fn is_resizable(&self) -> bool

source

pub fn set_enabled_buttons(&self, _buttons: WindowButtons)

source

pub fn enabled_buttons(&self) -> WindowButtons

source

pub fn scale_factor(&self) -> f64

source

pub fn set_blur(&self, blur: bool)

source

pub fn set_decorations(&self, decorate: bool)

source

pub fn is_decorated(&self) -> bool

source

pub fn set_window_level(&self, _level: WindowLevel)

source

pub(crate) fn set_window_icon(&self, _window_icon: Option<PlatformIcon>)

source

pub fn set_minimized(&self, minimized: bool)

source

pub fn is_maximized(&self) -> bool

source

pub fn set_maximized(&self, maximized: bool)

source

pub(crate) fn fullscreen(&self) -> Option<Fullscreen>

source

pub(crate) fn set_fullscreen(&self, fullscreen: Option<Fullscreen>)

source

pub fn set_cursor(&self, cursor: Cursor)

source

pub fn set_cursor_visible(&self, visible: bool)

source

pub fn request_user_attention(&self, request_type: Option<UserAttentionType>)

source

pub fn request_activation_token( &self, ) -> Result<AsyncRequestSerial, NotSupportedError>

source

pub fn set_cursor_grab(&self, mode: CursorGrabMode) -> Result<(), ExternalError>

source

pub fn set_cursor_position( &self, position: Position, ) -> Result<(), ExternalError>

source

pub fn drag_window(&self) -> Result<(), ExternalError>

source

pub fn set_cursor_hittest(&self, hittest: bool) -> Result<(), ExternalError>

source

pub fn set_ime_cursor_area(&self, position: Position, size: Size)

source

pub fn set_ime_allowed(&self, allowed: bool)

source

pub fn set_ime_purpose(&self, purpose: ImePurpose)

source

pub fn focus_window(&self)

source

pub fn surface(&self) -> &WlSurface

source

pub fn current_monitor(&self) -> Option<MonitorHandle>

source

pub fn available_monitors(&self) -> Vec<MonitorHandle>

source

pub fn primary_monitor(&self) -> Option<MonitorHandle>

source

pub fn raw_window_handle_rwh_06(&self) -> Result<RawWindowHandle, HandleError>

source

pub fn raw_display_handle_rwh_06(&self) -> Result<RawDisplayHandle, HandleError>

source

pub fn set_theme(&self, theme: Option<Theme>)

source

pub fn theme(&self) -> Option<Theme>

source

pub fn set_content_protected(&self, _protected: bool)

source

pub fn title(&self) -> String

Trait Implementations§

source§

impl Drop for Window

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl Freeze for Window

§

impl !RefUnwindSafe for Window

§

impl Send for Window

§

impl Sync for Window

§

impl Unpin for Window

§

impl !UnwindSafe for Window

Blanket Implementations§

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> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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<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