Struct ggez::conf::WindowMode

pub struct WindowMode {
    pub width: f32,
    pub height: f32,
    pub maximized: bool,
    pub fullscreen_type: FullscreenType,
    pub borderless: bool,
    pub min_width: f32,
    pub min_height: f32,
    pub max_width: f32,
    pub max_height: f32,
    pub hidpi: bool,
    pub resizable: bool,
}

A builder structure containing window settings that can be set at runtime and changed with graphics::set_mode().

Defaults:

WindowMode {
    width: 800.0,
    height: 600.0,
    maximized: false,
    fullscreen_type: FullscreenType::Windowed,
    borderless: false,
    min_width: 0.0,
    max_width: 0.0,
    min_height: 0.0,
    max_height: 0.0,
    hidpi: false,
    resizable: false,
}

Fields

width: f32

Window width

height: f32

Window height

maximized: bool

Whether or not to maximize the window

fullscreen_type: FullscreenType

Fullscreen type

borderless: bool

Whether or not to show window decorations

min_width: f32

Minimum width for resizable windows; 0 means no limit

min_height: f32

Minimum height for resizable windows; 0 means no limit

max_width: f32

Maximum width for resizable windows; 0 means no limit

max_height: f32

Maximum height for resizable windows; 0 means no limit

hidpi: bool

Whether or not to scale all "pixel" coordinates to deal with high DPI screens.

A very good overview of this is available in the winit docs. If this is false (the default), one pixel in ggez equates to one physical pixel on the screen. If it is true, then ggez will scale all pixel coordinates by the scaling factor returned by graphics::get_hidpi_factor().

TODO: This is not implemented properly yet because winit is stubborn.

resizable: bool

Whether or not the window is resizable

Methods

impl WindowMode

pub fn dimensions(self, width: f32, height: f32) -> Self

Set default window size, or screen resolution in true fullscreen mode.

pub fn maximized(self, maximized: bool) -> Self

Set whether the window should be maximized.

pub fn fullscreen_type(self, fullscreen_type: FullscreenType) -> Self

Set the fullscreen type.

pub fn borderless(self, borderless: bool) -> Self

Set whether a window should be borderless in windowed mode.

pub fn min_dimensions(self, width: f32, height: f32) -> Self

Set minimum window dimensions for windowed mode.

pub fn max_dimensions(self, width: f32, height: f32) -> Self

Set maximum window dimensions for windowed mode.

pub fn resizable(self, resizable: bool) -> Self

Set resizable.

pub fn hidpi(self, hidpi: bool) -> Self

Sets whether or not to allow hidpi.

Trait Implementations

impl PartialEq<WindowMode> for WindowMode

fn eq(&self, other: &WindowMode) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &WindowMode) -> bool

This method tests for !=.

impl Default for WindowMode

fn default() -> Self

Return WindowMode { width: 800.0, height: 600.0, maximized: false, fullscreen_type: FullscreenType :: Windowed, borderless: false, min_width: 0.0, min_height: 0.0, max_width: 0.0, max_height: 0.0, hidpi: false, resizable: false }

impl Clone for WindowMode

fn clone(&self) -> WindowMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for WindowMode

impl Debug for WindowMode

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for WindowMode

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for WindowMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.