Struct winit::window::WindowBuilder

source ·
pub struct WindowBuilder {
    pub window: WindowAttributes,
    pub(crate) platform_specific: PlatformSpecificWindowBuilderAttributes,
}
Expand description

Object that allows you to build windows.

Fields§

§window: WindowAttributes

The attributes to use to create the window.

§platform_specific: PlatformSpecificWindowBuilderAttributes

Implementations§

source§

impl WindowBuilder

source

pub fn new() -> Self

Initializes a new WindowBuilder with default values.

source

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.

source

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.

source

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.

source

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

Sets whether the window is resizable or not.

See Window::set_resizable for details.

source

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

Requests a specific title for the window.

See Window::set_title for details.

source

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

Sets the window fullscreen state.

See Window::set_fullscreen for details.

source

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

Requests maximized mode.

See Window::set_maximized for details.

source

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

Sets whether the window will be initially hidden or visible.

See Window::set_visible for details.

source

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

Sets whether the background of the window should be transparent.

source

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.

source

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.

source

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

Sets the window icon.

See Window::set_window_icon for details.

source

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§

source§

impl Clone for WindowBuilder

source§

fn clone(&self) -> WindowBuilder

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for WindowBuilder

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for WindowBuilder

source§

fn default() -> WindowBuilder

Returns the “default value” for a type. Read more
source§

impl WindowBuilderExtUnix for WindowBuilder

source§

fn with_x11_visual<T>(self, visual_infos: *const T) -> Self

source§

fn with_x11_screen(self, screen_id: i32) -> Self

source§

fn with_class(self, instance: String, class: String) -> Self

Build window with WM_CLASS hint; defaults to the name of the binary. Only relevant on X11.
source§

fn with_override_redirect(self, override_redirect: bool) -> Self

Build window with override-redirect flag; defaults to false. Only relevant on X11.
source§

fn with_x11_window_type(self, x11_window_types: Vec<XWindowType>) -> Self

Build window with _NET_WM_WINDOW_TYPE hints; defaults to Normal. Only relevant on X11.
source§

fn with_gtk_theme_variant(self, variant: String) -> Self

Build window with _GTK_THEME_VARIANT hint set to the specified value. Currently only relevant on X11.
source§

fn with_resize_increments<S: Into<Size>>(self, increments: S) -> Self

Build window with resize increment hint. Only implemented on X11.
source§

fn with_base_size<S: Into<Size>>(self, base_size: S) -> Self

Build window with base size hint. Only implemented on X11.
source§

fn with_app_id(self, app_id: String) -> Self

Build window with a given application ID. It should match the .desktop file distributed with your program. Only relevant on Wayland. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.