Struct Window

pub struct Window { /* private fields */ }

Represents a window.

Example

use tao::{
    event::{Event, WindowEvent},
    event_loop::{ControlFlow, EventLoop},
    window::Window,
};

let mut event_loop = EventLoop::new();
let window = Window::new(&event_loop).unwrap();

event_loop.run(move |event, _, control_flow| {
    *control_flow = ControlFlow::Wait;

    match event {
        Event::WindowEvent {
            event: WindowEvent::CloseRequested,
            ..
        } => *control_flow = ControlFlow::Exit,
        _ => (),
    }
});

Implementations

impl Window

Base Window functions.

pub fn new<T>(event_loop: &EventLoopWindowTarget<T>) -> Result<Window, OsError>

where T: 'static,

Creates a new Window for platforms where this is appropriate.

This function is equivalent to WindowBuilder::new().build(event_loop).

Error should be very rare and only occur in case of permission denied, incompatible system, out of memory, etc.

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.

See the dpi module for more information.

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.

Platform-specific

• Android: Always returns 1.0.
• iOS: Can only be called on the main thread. Returns the underlying UIView’s contentScaleFactor.

pub fn request_redraw(&self)

Emits a WindowEvent::RedrawRequested event in the associated event loop after all OS events have been processed by the event 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).

This function can cause RedrawRequested events to be emitted after Event::MainEventsCleared but before Event::NewEvents if called in the following circumstances:

• While processing MainEventsCleared.
• While processing a RedrawRequested event that was sent during MainEventsCleared or any directly subsequent RedrawRequested event.

Platform-specific

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

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 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.
• Android: 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.
• Android: Always returns NotSupportedError.
• Linux(Wayland): Has no effect, since Wayland doesn’t support a global cordinate system

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

where P: Into<Position>,

Modifies the position of the window.

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

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.
• Android / Linux(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.

pub fn set_inner_size<S>(&self, size: S)

where S: Into<Size>,

Modifies the inner size of the window.

See inner_size for more information about the values. This automatically un-maximizes the window if it’s maximized.

Platform-specific

• iOS / Android: Unsupported.

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 inner_size instead.

Platform-specific

• iOS: Can only be called on the main thread. Returns the PhysicalSize of the window in screen space coordinates.

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

where S: Into<Size>,

Sets a minimum dimension size for the window.

Platform-specific

• iOS / Android: Unsupported.

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

where S: Into<Size>,

Sets a maximum dimension size for the window.

Platform-specific

• iOS / Android: Unsupported.

pub fn set_inner_size_constraints(&self, constraints: WindowSizeConstraints)

Sets inner size constraints for the window.

Platform-specific

• iOS / Android: 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 title(&self) -> String

Gets the current title of the window.

Platform-specific

• iOS / Android: Unsupported. Returns ane empty string.

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: Unsupported.
• iOS: Can only be called on the main thread.

pub fn set_focus(&self)

Bring the window to front and focus.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_focused(&self) -> bool

Is window active and focused?

Platform-specific

• iOS / Android: Unsupported.

pub fn is_always_on_top(&self) -> bool

Indicates whether the window is always on top of other windows.

Platform-specific

• iOS / Android: 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 Resized, as that event can still be triggered by DPI scaling, entering fullscreen mode, etc.

Platform-specific

This only has an effect on desktop platforms.

Due to a bug in XFCE, this has no effect on Xfwm.

Platform-specific

• Linux: Most size methods like maximized are async and do not work well with calling sequentailly. For setting inner or outer size, you don’t need to set resizable to true before it. It can resize no matter what. But if you insist to do so, it has a 100, 100 minimum limitation somehow. For maximizing, it requires resizable is true. If you really want to set resizable to false after it. You might need a mechanism to check the window is really maximized.
• iOS / Android: Unsupported.

pub fn set_minimizable(&self, minimizable: bool)

Sets whether the window is minimizable or not.

Platform-specific

• Linux / iOS / Android: Unsupported.

pub fn set_maximizable(&self, maximizable: bool)

Sets whether the window is maximizable or not.

Platform-specific

• macOS: Disables the “zoom” button in the window titlebar, which is also used to enter fullscreen mode.
• Linux / iOS / Android: Unsupported.

pub fn set_closable(&self, closable: bool)

Sets whether the window is closable or not.

Platform-specific

• Linux: “GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible”
• iOS / Android: Unsupported.

pub fn set_minimized(&self, minimized: bool)

Sets the window to minimized or back

Platform-specific

• iOS / Android: Unsupported.

pub fn set_maximized(&self, maximized: bool)

Sets the window to maximized or back.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_maximized(&self) -> bool

Gets the window’s current maximized state.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_minimized(&self) -> bool

Gets the window’s current minimized state.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_visible(&self) -> bool

Gets the window’s current visibility state.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_resizable(&self) -> bool

Gets the window’s current resizable state.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_minimizable(&self) -> bool

Gets the window’s current minimizable state.

Platform-specific

• Linux / iOS / Android: Unsupported.

pub fn is_maximizable(&self) -> bool

Gets the window’s current maximizable state.

Platform-specific

• Linux / iOS / Android: Unsupported.

pub fn is_closable(&self) -> bool

Gets the window’s current closable state.

Platform-specific

• iOS / Android: Unsupported.

pub fn is_decorated(&self) -> bool

Gets the window’s current decoration state.

Platform-specific

• iOS / Android: 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 always disabled in fullscreen mode.

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

• Windows: Screen saver is disabled in fullscreen mode.

• Linux: The window will only fullscreen to current monitor no matter which enum variant.

• Android: Unsupported.

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: Will always return None.

pub fn set_decorations(&self, decorations: bool)

Turn window decorations on or off.

Platform-specific

• iOS / Android: Unsupported.

pub fn set_always_on_bottom(&self, always_on_bottom: bool)

Change whether or not the window will always be below other windows.

Platform-specific

• Windows: There is no guarantee that the window will be the bottom most but it will try to be.
• iOS / Android: Unsupported.

pub fn set_always_on_top(&self, always_on_top: bool)

Change whether or not the window will always be on top of other windows.

Platform-specific

• iOS / Android: Unsupported.

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

Sets the window icon. On Windows and Linux, this is typically the small icon in the top-left corner of the title bar.

Platform-specific

• iOS / Android / macOS: Unsupported.

On Windows, this 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.

pub fn set_ime_position<P>(&self, position: P)

where P: Into<Position>,

Sets location of IME candidate box in client area coordinates relative to the top left.

Platform-specific

• iOS / Android: Unsupported.

pub fn set_progress_bar(&self, _progress: ProgressBarState)

Sets the taskbar progress state.

Platform-specific

• Linux / macOS: Unlike windows, progress bar is app-wide and not specific to this window. Only supported desktop environments with libunity (e.g. GNOME).
• iOS / Android: Unsupported.

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: Unsupported.
• macOS: None has no effect.
• Linux: Urgency levels have the same effect.

pub fn theme(&self) -> Theme

Returns the current window theme.

Platform-specific

• iOS / Android: Unsupported.

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

Sets the theme for this window.

Platform-specific

• Linux / macOS: Theme is app-wide and not specific to this window.
• iOS / Android: Unsupported.

pub fn set_content_protection(&self, enabled: bool)

Prevents the window contents from being captured by other apps.

Platform-specific

• iOS / Android / Linux: Unsupported.

pub fn set_visible_on_all_workspaces(&self, visible: bool)

Sets whether the window should be visible on all workspaces.

Platform-specific

• iOS / Android / Windows: Unsupported.

pub fn set_background_color(&self, color: Option<(u8, u8, u8, u8)>)

Sets the window background color.

Platform-specific:

• Windows: alpha channel is ignored. Instead manually draw the window, for example using softbuffer crate, see https://github.com/tauri-apps/tao/blob/dev/examples/transparent.rs
• iOS / Android: Unsupported.

impl Window

Cursor functions.

pub fn set_cursor_icon(&self, cursor: CursorIcon)

Modifies the cursor icon of the window.

Platform-specific

• iOS / Android: Unsupported.

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

where P: Into<Position>,

Changes the position of the cursor in window coordinates.

Platform-specific

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

pub fn set_cursor_grab(&self, grab: bool) -> Result<(), ExternalError>

Grabs the cursor, preventing it from leaving the window.

There’s no guarantee that the cursor will be hidden. You should hide it by yourself if you want so.

Platform-specific

• macOS: This locks the cursor in a fixed location, which looks visually awkward.
• iOS / Android: Always returns an ExternalError::NotSupported.

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.
• 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

• macOS: May prevent the button release event to be triggered.
• iOS / Android: 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 / iOS / Android: Always returns an ExternalError::NotSupported.

pub fn set_ignore_cursor_events( &self, ignore: bool, ) -> Result<(), ExternalError>

Modifies whether the window catches cursor events.

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

Platform-specific

• iOS / Android: Always returns an ExternalError::NotSupported

pub fn cursor_position(&self) -> Result<PhysicalPosition<f64>, ExternalError>

Returns the current cursor position

Platform-specific

• iOS / Android / Linux(Wayland): Unsupported, returns 0,0.

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.

Platform-specific

iOS: Can only be called on the main thread.

pub fn monitor_from_point(&self, x: f64, y: f64) -> Option<MonitorHandle>

Returns the monitor that contains the given point.

Platform-specific:

• Android / iOS: Unsupported.

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 EventLoopWindowTarget::available_monitors, and is provided for convenience.

Platform-specific

iOS: Can only be called on the main thread.

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 EventLoopWindowTarget::primary_monitor, and is provided for convenience.

Platform-specific

iOS: Can only be called on the main thread.

Trait Implementations

impl Debug for Window

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

Formats the value using the given formatter.

impl Drop for Window

fn drop(&mut self)

Executes the destructor for this type.

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 WindowExtWindows for Window

fn hinstance(&self) -> isize

Returns the HINSTANCE of the window

fn hwnd(&self) -> isize

Returns the native handle that is used by this window.

fn set_enable(&self, enabled: bool)

Enables or disables mouse and keyboard input to the specified window.

fn set_taskbar_icon(&self, taskbar_icon: Option<Icon>)

This sets ICON_BIG. A good ceiling here is 256x256.

fn theme(&self) -> Theme

Returns the current window theme.

fn reset_dead_keys(&self)

Reset the dead key state of the keyboard.

fn begin_resize_drag(&self, edge: isize, button: u32, x: i32, y: i32)

Starts the resizing drag from given edge

fn set_skip_taskbar(&self, skip: bool) -> Result<(), ExternalError>

Whether to show the window icon in the taskbar or not.

fn set_undecorated_shadow(&self, shadow: bool)

Shows or hides the background drop shadow for undecorated windows.

fn set_rtl(&self, rtl: bool)

Sets right-to-left layout.

fn set_overlay_icon(&self, icon: Option<&Icon>)

This sets the overlay icon