Struct dotrix_core::window::Window

pub struct Window { /* fields omitted */ }

Window service - a wrapper for winit::window::Window instance.

Implementations

impl Window

pub fn get(&self) -> &WinitWindow

Gets the window handle from the wrapper

pub fn always_on_top(&self) -> bool

Check if the window will always be on top of other windows.

pub fn close(&mut self)

Closes the window. It will exit the game.

pub fn current_monitor(&self) -> &Monitor

Returns the monitor on which the window currently resides.

pub fn cursor_grab(&self) -> bool

Check if the cursor is grabbed (prevented from leaving the window).

pub fn cursor_icon(&self) -> CursorIcon

Get the cursor icon.

pub fn cursor_visible(&self) -> bool

Check the cursor’s visibility.

pub fn decorations(&self) -> bool

Check if the window have decorations.

pub fn fullscreen(&self) -> bool

Check if the window is in fullscreen mode.

pub fn inner_position(&self) -> Vec2i

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.

pub fn inner_size(&self) -> Vec2u

Returns the size of the window’s client area in pixels.

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

pub fn aspect_ratio(&self) -> f32

Returns current window aspect ratio

pub fn maximized(&self) -> bool

Check if the window is maximized.

pub fn min_inner_size(&self) -> Vec2u

Returns the minimum size of the window in pixels.

pub fn monitors(&self) -> &Vec<Monitor>

Returns a list of all available monitors.

pub fn outer_position(&self) -> Vec2i

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.

pub fn outer_size(&self) -> Vec2u

Returns the size of the entire window in pixels.

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

pub fn resizable(&self) -> bool

Check if the window is resizable or not.

pub fn request_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.

pub fn scale_factor(&self) -> f32

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

pub fn screen_size(&self) -> Vec2u

Returns the resolution of monitor on which the window currently resides.

pub fn set_always_on_top(&mut self, always_on_top: bool)

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

pub fn set_cursor_grab(&mut self, grab: bool)

Grabs the cursor, preventing it from leaving the window.

pub fn set_cursor_icon(&mut self, icon: CursorIcon)

Modifies the cursor icon of the window.

pub fn set_cursor_position(&self, pos: Vec2)

Change the position of the cursor in window in pixel coordinates.

pub fn set_cursor_visible(&mut self, visible: bool)

Modifies the cursor’s visibility.

pub fn set_decorations(&mut self, decorations: bool)

Turn window decorations on or off.

pub fn set_exclusive_fullscreen(&self, video_mode: VideoMode)

Sets the window to exclusive full screen mode with the given video mode.

Use set_fullscreen(None) to exit fullscreen.

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

Sets the window to fullscreen or back. You need to specify fullscreen mode.

Pass None to end fullscreen.

pub fn set_icon(&self, icon: Option<&Texture>)

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

pub fn set_inner_size(&self, size: Vec2u)

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.

pub fn set_maximized(&self, maximized: bool)

Sets the window to maximized or back.

pub fn set_minimized(&mut self, minimized: bool)

Sets the window to minimized or back.

pub fn set_min_inner_size(&mut self, min_size: Vec2u)

Sets a minimum size for the window. This automatically resize the window if it’s smaller than minimum size.

pub fn set_outer_position(&self, position: Vec2i)

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.

pub fn set_resizable(&mut self, resizable: bool)

Sets whether the window is resizable or not.

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

Modifies the title of the window.

pub fn title(&self) -> &str

Get the title of the window.

Trait Implementations

impl Default for Window

fn default() -> Self

Returns the “default value” for a type.