Struct amethyst_window::DisplayConfig

pub struct DisplayConfig {
    pub title: String,
    pub fullscreen: Option<MonitorIdent>,
    pub dimensions: Option<(u32, u32)>,
    pub min_dimensions: Option<(u32, u32)>,
    pub max_dimensions: Option<(u32, u32)>,
    pub visibility: bool,
    pub icon: Option<PathBuf>,
    pub always_on_top: bool,
    pub decorations: bool,
    pub maximized: bool,
    pub multitouch: bool,
    pub resizable: bool,
    pub transparent: bool,
    pub loaded_icon: Option<Icon>,
}

Configuration for a window display.

Fields

title: String

Name of the application window.

fullscreen: Option<MonitorIdent>

Enables fullscreen mode on specific monitor when set. Defaults to None, which means fullscreen is off.

dimensions: Option<(u32, u32)>

Current window dimensions, measured in pixels (px).

min_dimensions: Option<(u32, u32)>

Minimum window dimensions, measured in pixels (px).

max_dimensions: Option<(u32, u32)>

Maximum window dimensions, measured in pixels (px).

visibility: bool

Whether the window should be immediately visible upon creation.

icon: Option<PathBuf>

A path to the icon used for the window. If loaded_icon is present, this will be ignored.

always_on_top: bool

Whether the window should always be on top of other windows.

decorations: bool

Whether the window should have borders and bars.

maximized: bool

Whether the window should be maximized upon creation.

multitouch: bool

Enable multitouch on iOS.

resizable: bool

Whether the window is resizable or not.

transparent: bool

Whether the the window should be transparent. If this is true, writing colors with alpha values different than 1.0 will produce a transparent window.

loaded_icon: Option<Icon>

A programmatically loaded window icon; not present in serialization. Takes precedence over icon.

Examples

use amethyst_window::{DisplayConfig, Icon};

// First, create your `DisplayConfig` as usual
let mut config = DisplayConfig::default(); // or load from file

// Create the icon data
let mut icon = Vec::new();
for _ in 0..(128 * 128) {
    icon.extend(vec![255, 0, 0, 255]);
}

// Set the `loaded_icon` field of the config
// It will now be used as the window icon
config.loaded_icon = Some(Icon::from_rgba(icon, 128, 128).unwrap());

// Now, feed this into the `GameDataBuilder` using
// `.with_bundle(WindowBundle::from_config(config))`

Methods

impl DisplayConfig

pub fn into_window_builder(
    self,
    monitors: &impl MonitorsAccess
) -> WindowBuilder

Creates a winit::WindowBuilder using the values set in the DisplayConfig.

The MonitorsAccess is needed to configure a fullscreen window.

Trait Implementations

impl Default for DisplayConfig

fn default() -> Self

Returns the "default value" for a type.

impl Eq for DisplayConfig

impl Clone for DisplayConfig

fn clone(&self) -> DisplayConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<DisplayConfig> for DisplayConfig

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

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

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

This method tests for !=.

impl Debug for DisplayConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DisplayConfig

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

Deserialize this value from the given Serde deserializer.

impl Serialize for DisplayConfig

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

Serialize this value into the given Serde serializer.