Struct bevy::window::Window

pub struct Window { /* fields omitted */ }

An operating system window that can present content and receive user input.

Window Sizes

There are three sizes associated with a window. The physical size which is the height and width in physical pixels on the monitor. The logical size which is the physical size scaled by an operating system provided factor to account for monitors with differing pixel densities or user preference. And the requested size, measured in logical pixels, which is the value submitted to the API when creating the window, or requesting that it be resized.

The actual size, in logical pixels, of the window may not match the requested size due to operating system limits on the window size, or the quantization of the logical size when converting the physical size to the logical size through the scaling factor.

Implementations

impl Window

pub fn new(
    id: WindowId,
    window_descriptor: &WindowDescriptor,
    physical_width: u32,
    physical_height: u32,
    scale_factor: f64
) -> Window

pub fn id(&self) -> WindowId

pub fn width(&self) -> f32

The current logical width of the window's client area.

pub fn height(&self) -> f32

The current logical height of the window's client area.

pub fn requested_width(&self) -> f32

The requested window client area width in logical pixels from window creation or the last call to set_resolution.

This may differ from the actual width depending on OS size limits and the scaling factor for high DPI monitors.

pub fn requested_height(&self) -> f32

The requested window client area height in logical pixels from window creation or the last call to set_resolution.

This may differ from the actual width depending on OS size limits and the scaling factor for high DPI monitors.

pub fn physical_width(&self) -> u32

The window's client area width in physical pixels.

pub fn physical_height(&self) -> u32

The window's client area height in physical pixels.

pub fn set_maximized(&mut self, maximized: bool)

pub fn set_resolution(&mut self, width: f32, height: f32)

Request the OS to resize the window such the the client area matches the specified width and height.

pub fn update_scale_factor_from_backend(&mut self, scale_factor: f64)

pub fn update_actual_size_from_backend(
    &mut self,
    physical_width: u32,
    physical_height: u32
)

pub fn scale_factor(&self) -> f64

The ratio of physical pixels to logical pixels

physical_pixels = logical_pixels * scale_factor

pub fn title(&self) -> &str

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

pub fn vsync(&self) -> bool

pub fn set_vsync(&mut self, vsync: bool)

pub fn resizable(&self) -> bool

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

pub fn decorations(&self) -> bool

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

pub fn cursor_locked(&self) -> bool

pub fn set_cursor_lock_mode(&mut self, lock_mode: bool)

pub fn cursor_visible(&self) -> bool

pub fn set_cursor_visibility(&mut self, visibile_mode: bool)

pub fn cursor_position(&self) -> Option<Vec2>

pub fn set_cursor_position(&mut self, position: Vec2)

pub fn update_cursor_position_from_backend(
    &mut self,
    cursor_position: Option<Vec2>
)

pub fn mode(&self) -> WindowMode

pub fn set_mode(&mut self, mode: WindowMode)

pub fn drain_commands(&mut self) -> impl Iterator<Item = WindowCommand>

Trait Implementations

impl Debug for Window

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

Formats the value using the given formatter.