Struct winit::window::Window

pub struct Window {
    pub(crate) window: Window,
}

Represents a window.

The window is closed when dropped.

Threading

This is Send + Sync, meaning that it can be freely used from other threads.

However, some platforms (macOS, Web and iOS) only allow user interface interactions on the main thread, so on those platforms, if you use the window from a thread other than the main, the code is scheduled to run on the main thread, and your thread may be blocked until that completes.

Platform-specific

Web: The Window, which is represented by a HTMLElementCanvas, can not be closed by dropping the Window.

Fields

window: Window

Implementations

impl Window

Base Window functions.

pub fn default_attributes() -> WindowAttributes

Create a new WindowAttributes which allows modifying the window’s attributes before creation.

pub fn id(&self) -> WindowId

Returns an identifier unique to the window.

pub fn scale_factor(&self) -> f64

Returns the scale factor that can be used to map logical pixels to physical pixels, and vice versa.

Note that this value can change depending on user action (for example if the window is moved to another screen); as such, tracking WindowEvent::ScaleFactorChanged events is the most robust way to track the DPI you need to use to draw.

This value may differ from MonitorHandle::scale_factor.

See the dpi crate for more information.

Platform-specific

The scale factor is calculated differently on different platforms:

• Windows: On Windows 8 and 10, per-monitor scaling is readily configured by users from the display settings. While users are free to select any option they want, they’re only given a selection of “nice” scale factors, i.e. 1.0, 1.25, 1.5… on Windows 7. The scale factor is global and changing it requires logging out. See this article for technical details.

• macOS: Recent macOS versions allow the user to change the scaling factor for specific displays. When available, the user may pick a per-monitor scaling factor from a set of pre-defined settings. All “retina displays” have a scaling factor above 1.0 by default, but the specific value varies across devices.

• X11: Many man-hours have been spent trying to figure out how to handle DPI in X11. Winit currently uses a three-pronged approach:

  • Use the value in the WINIT_X11_SCALE_FACTOR environment variable if present.
  • If not present, use the value set in Xft.dpi in Xresources.
  • Otherwise, calculate the scale factor based on the millimeter monitor dimensions provided by XRandR.

  If WINIT_X11_SCALE_FACTOR is set to randr, it’ll ignore the Xft.dpi field and use the XRandR scaling method. Generally speaking, you should try to configure the standard system variables to do what you want before resorting to WINIT_X11_SCALE_FACTOR.

• Wayland: The scale factor is suggested by the compositor for each window individually by using the wp-fractional-scale protocol if available. Falls back to integer-scale factors otherwise.

  The monitor scale factor may differ from the window scale factor.

• iOS: Scale factors are set by Apple to the value that best suits the device, and range from 1.0 to 3.0. See this article and this article for more information.

  This uses the underlying UIView’s contentScaleFactor.

• Android: Scale factors are set by the manufacturer to the value that best suits the device, and range from 1.0 to 4.0. See this article for more information.

  This is currently unimplemented, and this function always returns 1.0.

• Web: The scale factor is the ratio between CSS pixels and the physical device pixels. In other words, it is the value of window.devicePixelRatio. It is affected by both the screen scaling and the browser zoom level and can go below 1.0.

• Orbital: This is currently unimplemented, and this function always returns 1.0.

pub fn request_redraw(&self)

Queues a WindowEvent::RedrawRequested event to be emitted that aligns with the windowing system drawing loop.

This is the strongly encouraged method of redrawing windows, as it can integrate with OS-requested redraws (e.g. when a window gets resized). To improve the event delivery consider using Window::pre_present_notify as described in docs.

Applications should always aim to redraw whenever they receive a RedrawRequested event.

There are no strong guarantees about when exactly a RedrawRequest event will be emitted with respect to other events, since the requirements can vary significantly between windowing systems.

However as the event aligns with the windowing system drawing loop, it may not arrive in same or even next event loop iteration.

Platform-specific

• Windows This API uses RedrawWindow to request a WM_PAINT message and RedrawRequested is emitted in sync with any WM_PAINT messages.
• iOS: Can only be called on the main thread.
• Wayland: The events are aligned with the frame callbacks when Window::pre_present_notify is used.
• Web: WindowEvent::RedrawRequested will be aligned with the requestAnimationFrame.

pub fn pre_present_notify(&self)

Notify the windowing system before presenting to the window.

You should call this event after your drawing operations, but before you submit the buffer to the display or commit your drawings. Doing so will help winit to properly schedule and make assumptions about its internal state. For example, it could properly throttle WindowEvent::RedrawRequested.

Example

This example illustrates how it looks with OpenGL, but it applies to other graphics APIs and software rendering.

// Do the actual drawing with OpenGL.

// Notify winit that we're about to submit buffer to the windowing system.
window.pre_present_notify();

// Submit buffer to the windowing system.
swap_buffers();

Platform-specific

• Android / iOS / X11 / Web / Windows / macOS / Orbital: Unsupported.
• Wayland: Schedules a frame callback to throttle WindowEvent::RedrawRequested.

pub fn reset_dead_keys(&self)

Reset the dead key state of the keyboard.

This is useful when a dead key is bound to trigger an action. Then this function can be called to reset the dead key state so that follow-up text input won’t be affected by the dead key.

Platform-specific

• Web, macOS: Does nothing

impl Window

Position and size functions.

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

Returns the position of the top-left hand corner of the window’s client area relative to the top-left hand corner of the desktop.

The same conditions that apply to Window::outer_position apply to this method.

Platform-specific

• iOS: Can only be called on the main thread. Returns the top left coordinates of the window’s safe area in the screen space coordinate system.
• Web: Returns the top-left coordinates relative to the viewport. Note: this returns the same value as Window::outer_position.
• Android / Wayland: Always returns NotSupportedError.

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

Returns the position of the top-left hand corner of the window relative to the top-left hand corner of the desktop.

Note that the top-left hand corner of the desktop is not necessarily the same as the screen. If the user uses a desktop with multiple monitors, the top-left hand corner of the desktop is the top-left hand corner of the monitor at the top-left of the desktop.

The coordinates can be negative if the top-left hand corner of the window is outside of the visible screen region.

Platform-specific

• iOS: Can only be called on the main thread. Returns the top left coordinates of the window in the screen space coordinate system.
• Web: Returns the top-left coordinates relative to the viewport.
• Android / Wayland: Always returns NotSupportedError.

pub fn set_outer_position<P: Into<Position>>(&self, position: P)

Modifies the position of the window.

See Window::outer_position for more information about the coordinates. This automatically un-maximizes the window if it’s maximized.

// Specify the position in logical dimensions like this:
window.set_outer_position(LogicalPosition::new(400.0, 200.0));

// Or specify the position in physical dimensions like this:
window.set_outer_position(PhysicalPosition::new(400, 200));

Platform-specific

• iOS: Can only be called on the main thread. Sets the top left coordinates of the window in the screen space coordinate system.
• Web: Sets the top-left coordinates relative to the viewport. Doesn’t account for CSS transform.
• Android / Wayland: Unsupported.

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

Returns the physical size of the window’s client area.

The client area is the content of the window, excluding the title bar and borders.

Platform-specific

• iOS: Can only be called on the main thread. Returns the PhysicalSize of the window’s safe area in screen space coordinates.
• Web: Returns the size of the canvas element. Doesn’t account for CSS transform.

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

Request the new size for the window.

On platforms where the size is entirely controlled by the user the applied size will be returned immediately, resize event in such case may not be generated.

On platforms where resizing is disallowed by the windowing system, the current inner size is returned immediately, and the user one is ignored.

When None is returned, it means that the request went to the display system, and the actual size will be delivered later with the WindowEvent::Resized.

See Window::inner_size for more information about the values.

The request could automatically un-maximize the window if it’s maximized.

// Specify the size in logical dimensions like this:
let _ = window.request_inner_size(LogicalSize::new(400.0, 200.0));

// Or specify the size in physical dimensions like this:
let _ = window.request_inner_size(PhysicalSize::new(400, 200));

Platform-specific

• Web: Sets the size of the canvas element. Doesn’t account for CSS transform.

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

Returns the physical size of the entire window.

These dimensions include the title bar and borders. If you don’t want that (and you usually don’t), use Window::inner_size instead.

Platform-specific

• iOS: Can only be called on the main thread. Returns the PhysicalSize of the window in screen space coordinates.
• Web: Returns the size of the canvas element. Note: this returns the same value as Window::inner_size.

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

Sets a minimum dimension size for the window.

// Specify the size in logical dimensions like this:
window.set_min_inner_size(Some(LogicalSize::new(400.0, 200.0)));

// Or specify the size in physical dimensions like this:
window.set_min_inner_size(Some(PhysicalSize::new(400, 200)));

Platform-specific

• iOS / Android / Orbital: Unsupported.

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

Sets a maximum dimension size for the window.

// Specify the size in logical dimensions like this:
window.set_max_inner_size(Some(LogicalSize::new(400.0, 200.0)));

// Or specify the size in physical dimensions like this:
window.set_max_inner_size(Some(PhysicalSize::new(400, 200)));

Platform-specific

• iOS / Android / Orbital: Unsupported.

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

Returns window resize increments if any were set.

Platform-specific

• iOS / Android / Web / Wayland / Orbital: Always returns None.

pub fn set_resize_increments<S: Into<Size>>(&self, increments: Option<S>)

Sets window resize increments.

This is a niche constraint hint usually employed by terminal emulators and other apps that need “blocky” resizes.

Platform-specific

• macOS: Increments are converted to logical size and then macOS rounds them to whole numbers.
• Wayland: Not implemented.
• iOS / Android / Web / Orbital: Unsupported.

impl Window

Misc. attribute functions.

pub fn set_title(&self, title: &str)

Modifies the title of the window.

Platform-specific

• iOS / Android: Unsupported.

pub fn set_transparent(&self, transparent: bool)

Change the window transparency state.

This is just a hint that may not change anything about the window transparency, however doing a mismatch between the content of your window and this hint may result in visual artifacts.

The default value follows the WindowAttributes::with_transparent.

Platform-specific

• macOS: This will reset the window’s background color.
• Web / iOS / Android: Unsupported.
• X11: Can only be set while building the window, with WindowAttributes::with_transparent.

pub fn set_blur(&self, blur: bool)

Change the window blur state.

If true, this will make the transparent window background blurry.

Platform-specific

• Android / iOS / X11 / Web / Windows: Unsupported.
• Wayland: Only works with org_kde_kwin_blur_manager protocol.

pub fn set_visible(&self, visible: bool)

Modifies the window’s visibility.

If false, this will hide the window. If true, this will show the window.

Platform-specific

• Android / Wayland / Web: Unsupported.
• iOS: Can only be called on the main thread.

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

Gets the window’s current visibility state.

None means it couldn’t be determined, so it is not recommended to use this to drive your rendering backend.

Platform-specific

• X11: Not implemented.
• Wayland / iOS / Android / Web: Unsupported.

pub fn set_resizable(&self, resizable: bool)

Sets whether the window is resizable or not.

Note that making the window unresizable doesn’t exempt you from handling WindowEvent::Resized, as that event can still be triggered by DPI scaling, entering fullscreen mode, etc. Also, the window could still be resized by calling Window::request_inner_size.

Platform-specific

This only has an effect on desktop platforms.

• X11: Due to a bug in XFCE, this has no effect on Xfwm.
• iOS / Android / Web: Unsupported.

pub fn is_resizable(&self) -> bool

Gets the window’s current resizable state.

Platform-specific

• X11: Not implemented.
• iOS / Android / Web: Unsupported.

pub fn set_enabled_buttons(&self, buttons: WindowButtons)

Sets the enabled window buttons.

Platform-specific

• Wayland / X11 / Orbital: Not implemented.
• Web / iOS / Android: Unsupported.

pub fn enabled_buttons(&self) -> WindowButtons

Gets the enabled window buttons.

Platform-specific

• Wayland / X11 / Orbital: Not implemented. Always returns WindowButtons::all.
• Web / iOS / Android: Unsupported. Always returns WindowButtons::all.

pub fn set_minimized(&self, minimized: bool)

Sets the window to minimized or back

Platform-specific

• iOS / Android / Web / Orbital: Unsupported.
• Wayland: Un-minimize is unsupported.

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

Gets the window’s current minimized state.

None will be returned, if the minimized state couldn’t be determined.

Note

• You shouldn’t stop rendering for minimized windows, however you could lower the fps.

Platform-specific

• Wayland: always None.
• iOS / Android / Web / Orbital: Unsupported.

pub fn set_maximized(&self, maximized: bool)

Sets the window to maximized or back.

Platform-specific

• iOS / Android / Web: Unsupported.

pub fn is_maximized(&self) -> bool

Gets the window’s current maximized state.

Platform-specific

• iOS / Android / Web: Unsupported.

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

Sets the window to fullscreen or back.

Platform-specific

• macOS: Fullscreen::Exclusive provides true exclusive mode with a video mode change. Caveat! macOS doesn’t provide task switching (or spaces!) while in exclusive fullscreen mode. This mode should be used when a video mode change is desired, but for a better user experience, borderless fullscreen might be preferred.

  Fullscreen::Borderless provides a borderless fullscreen window on a separate space. This is the idiomatic way for fullscreen games to work on macOS. See WindowExtMacOs::set_simple_fullscreen if separate spaces are not preferred.

  The dock and the menu bar are disabled in exclusive fullscreen mode.

• iOS: Can only be called on the main thread.

• Wayland: Does not support exclusive fullscreen mode and will no-op a request.

• Windows: Screen saver is disabled in fullscreen mode.

• Android / Orbital: Unsupported.

• Web: Does nothing without a transient activation.

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

Gets the window’s current fullscreen state.

Platform-specific

• iOS: Can only be called on the main thread.
• Android / Orbital: Will always return None.
• Wayland: Can return Borderless(None) when there are no monitors.
• Web: Can only return None or Borderless(None).

pub fn set_decorations(&self, decorations: bool)

Turn window decorations on or off.

Enable/disable window decorations provided by the server or Winit. By default this is enabled. Note that fullscreen windows and windows on mobile and web platforms naturally do not have decorations.

Platform-specific

• iOS / Android / Web: No effect.

pub fn is_decorated(&self) -> bool

Gets the window’s current decorations state.

Returns true when windows are decorated (server-side or by Winit). Also returns true when no decorations are required (mobile, web).

Platform-specific

• iOS / Android / Web: Always returns true.

pub fn set_window_level(&self, level: WindowLevel)

Change the window level.

This is just a hint to the OS, and the system could ignore it.

See WindowLevel for details.

pub fn set_window_icon(&self, window_icon: Option<Icon>)

Sets the window icon.

On Windows and X11, this is typically the small icon in the top-left corner of the titlebar.

Platform-specific

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

• Windows: Sets ICON_SMALL. The base size for a window icon is 16x16, but it’s recommended to account for screen scaling and pick a multiple of that, i.e. 32x32.

• X11: Has no universal guidelines for icon sizes, so you’re at the whims of the WM. That said, it’s usually in the same ballpark as on Windows.

pub fn set_ime_cursor_area<P: Into<Position>, S: Into<Size>>( &self, position: P, size: S, )

Set the IME cursor editing area, where the position is the top left corner of that area and size is the size of this area starting from the position. An example of such area could be a input field in the UI or line in the editor.

The windowing system could place a candidate box close to that area, but try to not obscure the specified area, so the user input to it stays visible.

The candidate box is the window / popup / overlay that allows you to select the desired characters. The look of this box may differ between input devices, even on the same platform.

(Apple’s official term is “candidate window”, see their chinese and japanese guides).

Example

// Specify the position in logical dimensions like this:
window.set_ime_cursor_area(LogicalPosition::new(400.0, 200.0), LogicalSize::new(100, 100));

// Or specify the position in physical dimensions like this:
window.set_ime_cursor_area(PhysicalPosition::new(400, 200), PhysicalSize::new(100, 100));

Platform-specific

• X11: - area is not supported, only position.
• iOS / Android / Web / Orbital: Unsupported.

pub fn set_ime_allowed(&self, allowed: bool)

Sets whether the window should get IME events

When IME is allowed, the window will receive Ime events, and during the preedit phase the window will NOT get KeyboardInput events. The window should allow IME while it is expecting text input.

When IME is not allowed, the window won’t receive Ime events, and will receive KeyboardInput events for every keypress instead. Not allowing IME is useful for games for example.

IME is not allowed by default.

Platform-specific

• macOS: IME must be enabled to receive text-input where dead-key sequences are combined.
• iOS / Android / Web / Orbital: Unsupported.
• X11: Enabling IME will disable dead keys reporting during compose.

pub fn set_ime_purpose(&self, purpose: ImePurpose)

Sets the IME purpose for the window using ImePurpose.

Platform-specific

• iOS / Android / Web / Windows / X11 / macOS / Orbital: Unsupported.

pub fn focus_window(&self)

Brings the window to the front and sets input focus. Has no effect if the window is already in focus, minimized, or not visible.

This method steals input focus from other applications. Do not use this method unless you are certain that’s what the user wants. Focus stealing can cause an extremely disruptive user experience.

Platform-specific

• iOS / Android / Wayland / Orbital: Unsupported.

pub fn has_focus(&self) -> bool

Gets whether the window has keyboard focus.

This queries the same state information as WindowEvent::Focused.

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

Requests user attention to the window, this has no effect if the application is already focused. How requesting for user attention manifests is platform dependent, see UserAttentionType for details.

Providing None will unset the request for user attention. Unsetting the request for user attention might not be done automatically by the WM when the window receives input.

Platform-specific

• iOS / Android / Web / Orbital: Unsupported.
• macOS: None has no effect.
• X11: Requests for user attention must be manually cleared.
• Wayland: Requires xdg_activation_v1 protocol, None has no effect.

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

Set or override the window theme.

Specify None to reset the theme to the system default.

Platform-specific

• Wayland: Sets the theme for the client side decorations. Using None will use dbus to get the system preference.
• X11: Sets _GTK_THEME_VARIANT hint to dark or light and if None is used, it will default to Theme::Dark.
• iOS / Android / Web / Orbital: Unsupported.

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

Returns the current window theme.

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

Platform-specific

• iOS / Android / x11 / Orbital: Unsupported.
• Wayland: Only returns theme overrides.

pub fn set_content_protected(&self, protected: bool)

Prevents the window contents from being captured by other apps.

Platform-specific

• macOS: if false, NSWindowSharingNone is used but doesn’t completely prevent all apps from reading the window content, for instance, QuickTime.
• iOS / Android / x11 / Wayland / Web / Orbital: Unsupported.

pub fn title(&self) -> String

Gets the current title of the window.

Platform-specific

• iOS / Android / x11 / Wayland / Web: Unsupported. Always returns an empty string.

impl Window

Cursor functions.

pub fn set_cursor(&self, cursor: impl Into<Cursor>)

Modifies the cursor icon of the window.

Platform-specific

• iOS / Android / Orbital: Unsupported.
• Web: Custom cursors have to be loaded and decoded first, until then the previous cursor is shown.

pub fn set_cursor_icon(&self, icon: CursorIcon)

👎Deprecated: Renamed to set_cursor

Deprecated! Use Window::set_cursor() instead.

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

Changes the position of the cursor in window coordinates.

// Specify the position in logical dimensions like this:
window.set_cursor_position(LogicalPosition::new(400.0, 200.0));

// Or specify the position in physical dimensions like this:
window.set_cursor_position(PhysicalPosition::new(400, 200));

Platform-specific

• Wayland: Cursor must be in CursorGrabMode::Locked.
• iOS / Android / Web / Orbital: Always returns an ExternalError::NotSupported.

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

Set grabbing mode on the cursor preventing it from leaving the window.

Example

First try confining the cursor, and if that fails, try locking it instead.

window
    .set_cursor_grab(CursorGrabMode::Confined)
    .or_else(|_e| window.set_cursor_grab(CursorGrabMode::Locked))
    .unwrap();

pub fn set_cursor_visible(&self, visible: bool)

Modifies the cursor’s visibility.

If false, this will hide the cursor. If true, this will show the cursor.

Platform-specific

• Windows: The cursor is only hidden within the confines of the window.
• X11: The cursor is only hidden within the confines of the window.
• Wayland: The cursor is only hidden within the confines of the window.
• macOS: The cursor is hidden as long as the window has input focus, even if the cursor is outside of the window.
• iOS / Android: Unsupported.

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

Moves the window with the left mouse button until the button is released.

There’s no guarantee that this will work unless the left mouse button was pressed immediately before this function is called.

Platform-specific

• X11: Un-grabs the cursor.
• Wayland: Requires the cursor to be inside the window to be dragged.
• macOS: May prevent the button release event to be triggered.
• iOS / Android / Web: Always returns an ExternalError::NotSupported.

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

Resizes the window with the left mouse button until the button is released.

There’s no guarantee that this will work unless the left mouse button was pressed immediately before this function is called.

Platform-specific

• macOS: Always returns an ExternalError::NotSupported
• iOS / Android / Web: Always returns an ExternalError::NotSupported.

pub fn show_window_menu(&self, position: impl Into<Position>)

Show window menu at a specified position .

This is the context menu that is normally shown when interacting with the title bar. This is useful when implementing custom decorations.

Platform-specific

Android / iOS / macOS / Orbital / Wayland / Web / X11: Unsupported.

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

Modifies whether the window catches cursor events.

If true, the window will catch the cursor events. If false, events are passed through the window such that any other window behind it receives them. By default hittest is enabled.

Platform-specific

• iOS / Android / Web / Orbital: Always returns an ExternalError::NotSupported.

impl Window

Monitor info functions.

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

Returns the monitor on which the window currently resides.

Returns None if current monitor can’t be detected.

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

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

This is the same as ActiveEventLoop::available_monitors, and is provided for convenience.

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.

This is the same as ActiveEventLoop::primary_monitor, and is provided for convenience.

Platform-specific

Wayland / Web: Always returns None.

Trait Implementations

impl Debug for Window

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

Formats the value using the given formatter.

impl Drop for Window

fn drop(&mut self)

This will close the Window.

See Window for more details.

impl HasDisplayHandle for Window

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

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

impl HasWindowHandle for Window

fn window_handle(&self) -> Result<WindowHandle<'_>, HandleError>

Get a handle to the window.

impl WindowExtStartupNotify for Window

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

Request a new activation token.

impl WindowExtWayland for Window

impl WindowExtX11 for Window