Struct ActiveEventLoop

pub struct ActiveEventLoop { /* private fields */ }

Target that associates windows with an EventLoop.

This type exists to allow you to create new windows while Winit executes your callback.

Implementations

impl ActiveEventLoop

pub fn create_window( &self, window_attributes: WindowAttributes, ) -> Result<Window, OsError>

Create the window.

Possible causes of error include denied permission, incompatible system, and lack of memory.

Platform-specific

• Web: The window is created but not inserted into the web page automatically. Please see the web platform module for more information.

pub fn create_custom_cursor( &self, custom_cursor: CustomCursorSource, ) -> CustomCursor

Create custom cursor.

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 system_theme(&self) -> Option<Theme>

Returns the current system theme.

Returns None if it cannot be determined on the current platform.

Platform-specific

• iOS / Android / Wayland / x11 / 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().

pub fn owned_display_handle(&self) -> OwnedDisplayHandle

Gets a persistent reference to the underlying platform display.

See the OwnedDisplayHandle type for more information.

Trait Implementations

impl ActiveEventLoopExtAndroid for ActiveEventLoop

Available on android_platform only.

fn android_app(&self) -> &AndroidApp

Get the [AndroidApp] which was used to create this event loop.

impl ActiveEventLoopExtMacOS for ActiveEventLoop

Available on macos_platform only.

fn hide_application(&self)

Hide the entire application. In most applications this is typically triggered with Command-H.

fn hide_other_applications(&self)

Hide the other applications. In most applications this is typically triggered with Command+Option-H.

fn set_allows_automatic_window_tabbing(&self, enabled: bool)

Set whether the system can automatically organize windows into tabs.

fn allows_automatic_window_tabbing(&self) -> bool

Returns whether the system can automatically organize windows into tabs.

impl ActiveEventLoopExtWayland for ActiveEventLoop

Available on wayland_platform only.

fn is_wayland(&self) -> bool

True if the ActiveEventLoop uses Wayland.

impl ActiveEventLoopExtWebSys for ActiveEventLoop

Available on web_platform only.

fn create_custom_cursor_async( &self, source: CustomCursorSource, ) -> CustomCursorFuture

Async version of ActiveEventLoop::create_custom_cursor() which waits until the cursor has completely finished loading.

fn set_poll_strategy(&self, strategy: PollStrategy)

Sets the strategy for ControlFlow::Poll.

fn poll_strategy(&self) -> PollStrategy

Gets the strategy for ControlFlow::Poll.

fn set_wait_until_strategy(&self, strategy: WaitUntilStrategy)

Sets the strategy for ControlFlow::WaitUntil.

fn wait_until_strategy(&self) -> WaitUntilStrategy

Gets the strategy for ControlFlow::WaitUntil.

impl ActiveEventLoopExtX11 for ActiveEventLoop

Available on x11_platform only.

fn is_x11(&self) -> bool

True if the ActiveEventLoop uses X11.

impl Debug for ActiveEventLoop

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

Formats the value using the given formatter.

impl EventLoopExtStartupNotify for ActiveEventLoop

Available on x11_platform or wayland_platform only.

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

Read the token from the environment.

impl HasDisplayHandle for ActiveEventLoop

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.