Struct dx::foundation::AsyncApplication

source · [−]

pub struct AsyncApplication {
    pub window: Arc<Window>,
}

Expand description

AsyncApplication runner.

This runner shall be used whenever wanted to debug a application.

Fields

window: Arc<Window>

Implementations

source

impl AsyncApplication

source

pub fn run<D>(context: D::Context, settings: ApplicationSettings) where
D: AsyncActivityHost<Self> + 'static,

Entrypoint for application launcher

source

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

X11: This respects Xft.dpi, and can be overridden using the WINIT_X11_SCALE_FACTOR environment variable.
Android: Always returns 1.0.
iOS: Can only be called on the main thread. Returns the underlying UIView’s contentScaleFactor.

source

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.
Web: Returns the top-left coordinates relative to the viewport. Note: this returns the same value as outer_position.
Android / Wayland: Always returns NotSupportedError.

source

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.

source

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

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.
Web: Sets the top-left coordinates relative to the viewport.
Android / Wayland: Unsupported.

source

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.

source

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

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.
Web: Sets the size of the canvas element.

source

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.
Web: Returns the size of the canvas element. Note: this returns the same value as inner_size.

source

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

Sets a minimum dimension size for the window.

Platform-specific

iOS / Android / Web: Unsupported.

source

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

Sets a maximum dimension size for the window.

Platform-specific

iOS / Android / Web: Unsupported.

source

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

Modifies the title of the window.

Platform-specific

iOS / Android: Unsupported.

source

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.

source

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

iOS / Android / Web: Unsupported.

source

pub fn set_minimized(&self, minimized: bool)

Sets the window to minimized or back

Platform-specific

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

source

pub fn set_maximized(&self, maximized: bool)

Sets the window to maximized or back.

Platform-specific

iOS / Android / Web: Unsupported.

source

pub fn is_maximized(&self) -> bool

Gets the window’s current maximized state.

Platform-specific

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

source

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.
Wayland: Does not support exclusive fullscreen mode and will no-op a request.
Windows: Screen saver is disabled in fullscreen mode.
Android: Unsupported.

source

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.
Wayland: Can return Borderless(None) when there are no monitors.

source

pub fn set_decorations(&self, decorations: bool)

Turn window decorations on or off.

Platform-specific

iOS / Android / Web: Unsupported.

source

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 / Web / Wayland: Unsupported.

source

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

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.

source

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

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

Platform-specific

iOS / Android / Web: Unsupported.

source

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 / Wayland: Unsupported.
macOS: None has no effect.
X11: Requests for user attention must be manually cleared.

source

pub fn set_cursor_icon(&self, cursor: CursorIcon)

Modifies the cursor icon of the window.

Platform-specific

iOS / Android: Unsupported.

source

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

Changes the position of the cursor in window coordinates.

Platform-specific

iOS / Android / Web / Wayland: Always returns an ExternalError::NotSupported.

source

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 / Web: Always returns an ExternalError::NotSupported.

source

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.

source