pub struct Window { /* private fields */ }
Expand description

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

Base Window functions.

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.

Returns an identifier unique to the window.

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.

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.

Position and size functions.

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.

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.

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: Unsupported.

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.

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.

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.

Sets a minimum dimension size for the window.

Platform-specific
  • iOS / Android: Unsupported.

Sets a maximum dimension size for the window.

Platform-specific
  • iOS / Android: Unsupported.

Misc. attribute functions.

Modifies the title of the window.

Platform-specific
  • iOS / Android: Unsupported.

Modifies the menu of the window.

Platform-specific
  • Windows: Unsupported.

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.

Bring the window to front and focus.

Platform-specific
  • iOS / Android: Unsupported.

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
  • iOS / Android: Unsupported.

Sets the window to minimized or back

Platform-specific
  • iOS / Android: Unsupported.

Sets the window to maximized or back.

Platform-specific
  • iOS / Android: Unsupported.

Gets the window’s current maximized state.

Platform-specific
  • iOS / Android: Unsupported.

Gets the window’s current vibility state.

Platform-specific
  • iOS / Android: Unsupported.

Gets the window’s current resizable state.

Platform-specific
  • iOS / Android: Unsupported.

Gets the window’s current decoration state.

Platform-specific
  • iOS / Android: Unsupported.

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.

Gets the window’s current fullscreen state.

Platform-specific
  • iOS: Can only be called on the main thread.
  • Android: Will always return None.

Turn window decorations on or off.

Platform-specific
  • iOS / Android: Unsupported.

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

Platform-specific
  • iOS / Android: Unsupported.

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.

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

Platform-specific
  • iOS / Android: Unsupported.

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.

Hides the menu associated with the window

Platform-specific
  • macOs/ iOS / Android: Unsupported.

Shows the menu associated with the window

Platform-specific
  • macOs/ iOS / Android: Unsupported.

Gets the visibilty of the window menu.

Platform-specific
  • iOS / Android: Unsupported.
  • macOS: Always return true, as the menu is always visible.

Cursor functions.

Modifies the cursor icon of the window.

Platform-specific
  • iOS / Android: Unsupported.

Changes the position of the cursor in window coordinates.

Platform-specific

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.

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.

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

Monitor info functions.

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.

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.

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

Formats the value using the given formatter. Read more

Executes the destructor for this type. Read more

Returns a raw_window_handle::RawWindowHandle for the Window

Platform-specific
  • Android: Only available after receiving the Resumed event and before Suspended. If you try to get the handle outside of that period, this function will panic!

Returns the ApplicatonWindow from gtk crate that is used by this window.

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

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.