Struct WindowCreationOptions 

pub struct WindowCreationOptions { /* private fields */ }

Options used during the creation of a window.

Implementations

impl WindowCreationOptions

pub fn new_windowed(size: WindowSize, position: Option<WindowPosition>) -> Self

Instantiates a new WindowCreationOptions structure with the default options, in non-fullscreen mode.

pub fn new_fullscreen_borderless() -> Self

Instantiates a new WindowCreationOptions structure with the default options, in borderless fullscreen mode.

pub fn with_multisampling(self, multisampling: u16) -> Self

Sets the maximum level of multisampling which will be applied. By default this is set to 16.

Note that this depends on platform support, and setting this may have no effect.

pub fn with_vsync(self, vsync: bool) -> Self

Sets whether or not vsync should be enabled. This can increase latency, but should eliminate tearing. By default this is set to true.

Note that this depends on platform support, and setting this may have no effect.

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

Sets whether or not the window can be resized by the user. The default is true.

pub fn with_minimizable(self, minimizable: bool) -> Self

Sets whether the window shows an enabled minimize button. The default is true.

Note that this depends on platform support, and setting this may have no effect.

pub fn with_maximizable(self, maximizable: bool) -> Self

Sets whether the window shows an enabled maximize button. The default is true. Note that a non-resizable window also can’t be maximized on most platforms.

Note that this depends on platform support, and setting this may have no effect.

pub fn with_always_on_top(self, always_on_top: bool) -> Self

If set to true, the window will be placed above other windows. The default is false.

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

If set to true, the window will be initially maximized. The default is false.

pub fn with_decorations(self, decorations: bool) -> Self

If set to false, the window will have no border. The default is true.

pub fn with_transparent(self, transparent: bool) -> Self

Sets whether the background of the window should be transparent. The default is false.

Note that this depends on platform support, and setting this may have no effect.

pub fn with_visible(self, visible: bool) -> Self

If set to false, the window will not be shown when it is created. It can be shown later using WindowHelper::set_visible. This is useful for applications that live in the system tray and only show a window on demand. The default is true.

For WebCanvas, this option has no effect.

pub fn with_hide_on_close(self, hide_on_close: bool) -> Self

If set to true, clicking the window’s close button will hide the window instead of closing it and terminating the application. The window can be shown again using WindowHelper::set_visible. This is useful for applications that should keep running in the system tray after the window is closed. The default is false.

This applies to every window created with these options, including the main window. Note that with this enabled, closing the main window no longer exits the app; use WindowHelper::terminate_loop for that.

For WebCanvas, this option has no effect.

Trait Implementations

impl Clone for WindowCreationOptions

fn clone(&self) -> WindowCreationOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WindowCreationOptions

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

Formats the value using the given formatter.

impl PartialEq for WindowCreationOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WindowCreationOptions