Struct winit::window::WindowBuilder

pub struct WindowBuilder {
    pub window: WindowAttributes,
    // some fields omitted
}

Object that allows you to build windows.

Fields

window: WindowAttributes

The attributes to use to create the window.

Implementations

impl WindowBuilder

pub fn new() -> Self

Initializes a new WindowBuilder with default values.

pub fn with_inner_size<S: Into<Size>>(self, size: S) -> Self

Requests the window to be of specific dimensions.

See Window::set_inner_size for details.

pub fn with_min_inner_size<S: Into<Size>>(self, min_size: S) -> Self

Sets a minimum dimension size for the window.

See Window::set_min_inner_size for details.

pub fn with_max_inner_size<S: Into<Size>>(self, max_size: S) -> Self

Sets a maximum dimension size for the window.

See Window::set_max_inner_size for details.

pub fn with_position<P: Into<Position>>(self, position: P) -> Self

Sets a desired initial position for the window.

See WindowAttributes::position for details.

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

Sets whether the window is resizable or not.

See Window::set_resizable for details.

pub fn with_title<T: Into<String>>(self, title: T) -> Self

Requests a specific title for the window.

See Window::set_title for details.

pub fn with_fullscreen(self, fullscreen: Option<Fullscreen>) -> Self

Sets the window fullscreen state.

See Window::set_fullscreen for details.

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

Requests maximized mode.

See Window::set_maximized for details.

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

Sets whether the window will be initially hidden or visible.

See Window::set_visible for details.

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

Sets whether the background of the window should be transparent.

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

Sets whether the window should have a border, a title bar, etc.

See Window::set_decorations for details.

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

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

See Window::set_always_on_top for details.

pub fn with_window_icon(self, window_icon: Option<Icon>) -> Self

Sets the window icon.

See Window::set_window_icon for details.

pub fn build<T: 'static>(
    self,
    window_target: &EventLoopWindowTarget<T>
) -> Result<Window, OsError>

Builds the window.

Possible causes of error include denied permission, incompatible system, and lack of memory.

Platform-specific behavior:

• Web: The window is created but not inserted into the web page automatically. Please see the web platform module for more information.

Trait Implementations

impl Clone for WindowBuilder

fn clone(&self) -> WindowBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowBuilder

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

Formats the value using the given formatter.

impl Default for WindowBuilder

fn default() -> WindowBuilder

Returns the “default value” for a type.

impl WindowBuilderExtWindows for WindowBuilder

fn with_parent_window(self, parent: HWND) -> WindowBuilder

Sets a parent to the window to be created.

fn with_owner_window(self, parent: HWND) -> WindowBuilder

Set an owner to the window to be created. Can be used to create a dialog box, for example. Can be used in combination with WindowExtWindows::set_enable(false) on the owner window to create a modal dialog box.

fn with_menu(self, menu: HMENU) -> WindowBuilder

Sets a menu on the window to be created.

fn with_taskbar_icon(self, taskbar_icon: Option<Icon>) -> WindowBuilder

This sets ICON_BIG. A good ceiling here is 256x256.

fn with_no_redirection_bitmap(self, flag: bool) -> WindowBuilder

This sets WS_EX_NOREDIRECTIONBITMAP.

fn with_drag_and_drop(self, flag: bool) -> WindowBuilder

Enables or disables drag and drop support (enabled by default). Will interfere with other crates that use multi-threaded COM API (CoInitializeEx with COINIT_MULTITHREADED instead of COINIT_APARTMENTTHREADED) on the same thread. Note that winit may still attempt to initialize COM API regardless of this option. Currently only fullscreen mode does that, but there may be more in the future. If you need COM API with COINIT_MULTITHREADED you must initialize it before calling any winit functions. See https://docs.microsoft.com/en-us/windows/win32/api/objbase/nf-objbase-coinitialize#remarks for more information.

fn with_theme(self, theme: Option<Theme>) -> WindowBuilder

Forces a theme or uses the system settings if None was provided.