Struct winit::event_loop::EventLoopWindowTarget

pub struct EventLoopWindowTarget<T: 'static> { /* private fields */ }

Target that associates windows with an EventLoop.

This type exists to allow you to create new windows while Winit executes your callback. EventLoop will coerce into this type (impl<T> Deref for EventLoop<T>), so functions that take this as a parameter can also take &EventLoop.

Implementations

impl<T> EventLoopWindowTarget<T>

pub fn available_monitors(&self) -> impl Iterator<Item = MonitorHandle>

Returns the list of all the monitors available on the system.

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

Returns the primary monitor of the system.

Returns None if it can’t identify any monitor as a primary one.

Platform-specific

Wayland / Web: Always returns None.

pub fn listen_device_events(&self, allowed: DeviceEvents)

Change if or when DeviceEvents are captured.

Since the DeviceEvent capture can lead to high CPU usage for unfocused windows, winit will ignore them by default for unfocused windows on Linux/BSD. This method allows changing this at runtime to explicitly capture them again.

Platform-specific

• Wayland / macOS / iOS / Android / Orbital: Unsupported.

pub fn set_control_flow(&self, control_flow: ControlFlow)

Sets the ControlFlow.

pub fn control_flow(&self) -> ControlFlow

Gets the current ControlFlow.

pub fn exit(&self)

This exits the event loop.

See LoopExiting.

pub fn exiting(&self) -> bool

Returns if the EventLoop is about to stop.

See exit().

Trait Implementations

impl<T> Debug for EventLoopWindowTarget<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> EventLoopExtStartupNotify for EventLoopWindowTarget<T>

Available on x11_platform or wayland_platform only.

fn read_token_from_env(&self) -> Option<ActivationToken>

Read the token from the environment.

impl<T> EventLoopWindowTargetExtWayland for EventLoopWindowTarget<T>

Available on wayland_platform only.

fn is_wayland(&self) -> bool

True if the EventLoopWindowTarget uses Wayland.

impl<T> EventLoopWindowTargetExtX11 for EventLoopWindowTarget<T>

Available on x11_platform only.

fn is_x11(&self) -> bool

True if the EventLoopWindowTarget uses X11.

impl<T> HasDisplayHandle for EventLoopWindowTarget<T>

Available on crate feature rwh_06 only.

fn display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>

Get a handle to the display controller of the windowing system.

impl<T> HasRawDisplayHandle for EventLoopWindowTarget<T>

Available on crate feature rwh_05 only.

fn raw_display_handle(&self) -> RawDisplayHandle

Returns a rwh_05::RawDisplayHandle for the event loop.