Struct WindowAttributes

pub struct WindowAttributes {

    pub surface_size: Option<Size>,
    pub min_surface_size: Option<Size>,
    pub max_surface_size: Option<Size>,
    pub surface_resize_increments: Option<Size>,
    pub position: Option<Position>,
    pub resizable: bool,
    pub enabled_buttons: WindowButtons,
    pub title: String,
    pub maximized: bool,
    pub visible: bool,
    pub transparent: bool,
    pub blur: bool,
    pub decorations: bool,
    pub window_icon: Option<Icon>,
    pub preferred_theme: Option<Theme>,
    pub content_protected: bool,
    pub window_level: WindowLevel,
    pub active: bool,
    pub cursor: Cursor,
    pub fullscreen: Option<Fullscreen>,
    /* private fields */
}

Attributes used when creating a window.

Fields

surface_size: Option<Size>

min_surface_size: Option<Size>

max_surface_size: Option<Size>

surface_resize_increments: Option<Size>

position: Option<Position>

resizable: bool

enabled_buttons: WindowButtons

title: String

maximized: bool

visible: bool

transparent: bool

blur: bool

decorations: bool

window_icon: Option<Icon>

preferred_theme: Option<Theme>

content_protected: bool

window_level: WindowLevel

active: bool

cursor: Cursor

fullscreen: Option<Fullscreen>

Implementations

impl WindowAttributes

pub fn parent_window(&self) -> Option<&RawWindowHandle>

Get the parent window stored on the attributes.

pub fn with_surface_size<S>(self, size: S) -> WindowAttributes

where S: Into<Size>,

Requests the surface to be of specific dimensions.

If this is not set, some platform-specific dimensions will be used.

See Window::request_surface_size for details.

pub fn with_min_surface_size<S>(self, min_size: S) -> WindowAttributes

where S: Into<Size>,

Sets the minimum dimensions the surface can have.

If this is not set, the surface will have no minimum dimensions (aside from reserved).

See Window::set_min_surface_size for details.

pub fn with_max_surface_size<S>(self, max_size: S) -> WindowAttributes

where S: Into<Size>,

Sets the maximum dimensions the surface can have.

If this is not set, the surface will have no maximum, or the maximum will be restricted to the primary monitor’s dimensions by the platform.

See Window::set_max_surface_size for details.

pub fn with_surface_resize_increments<S>( self, surface_resize_increments: S, ) -> WindowAttributes

where S: Into<Size>,

Build window with resize increments hint.

The default is None.

See Window::set_surface_resize_increments for details.

pub fn with_position<P>(self, position: P) -> WindowAttributes

where P: Into<Position>,

Sets a desired initial position for the window.

If this is not set, some platform-specific position will be chosen.

See Window::set_outer_position for details.

Platform-specific

• macOS: The top left corner position of the window content, the window’s “inner” position. The window title bar will be placed above it. The window will be positioned such that it fits on screen, maintaining set surface_size if any. If you need to precisely position the top left corner of the whole window you have to use Window::set_outer_position after creating the window.
• Windows: The top left corner position of the window title bar, the window’s “outer” position. There may be a small gap between this position and the window due to the specifics of the Window Manager.
• X11: The top left corner of the window, the window’s “outer” position.
• Others: Ignored.

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

Sets whether the window is resizable or not.

The default is true.

See Window::set_resizable for details.

pub fn with_enabled_buttons(self, buttons: WindowButtons) -> WindowAttributes

Sets the enabled window buttons.

The default is WindowButtons::all

See Window::set_enabled_buttons for details.

pub fn with_title<T>(self, title: T) -> WindowAttributes

where T: Into<String>,

Sets the initial title of the window in the title bar.

The default is "winit window".

See Window::set_title for details.

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

Sets whether the window should be put into fullscreen upon creation.

The default is None.

See Window::set_fullscreen for details.

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

Request that the window is maximized upon creation.

The default is false.

See Window::set_maximized for details.

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

Sets whether the window will be initially visible or hidden.

The default is to show the window.

See Window::set_visible for details.

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

Sets whether the background of the window should be transparent.

If this is true, writing colors with alpha values different than 1.0 will produce a transparent window. On some platforms this is more of a hint for the system and you’d still have the alpha buffer. To control it see Window::set_transparent.

The default is false.

pub fn with_blur(self, blur: bool) -> WindowAttributes

Sets whether the background of the window should be blurred by the system.

The default is false.

See Window::set_blur for details.

pub fn transparent(&self) -> bool

Get whether the window will support transparency.

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

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

The default is true.

See Window::set_decorations for details.

pub fn with_window_level(self, level: WindowLevel) -> WindowAttributes

Sets the window level.

This is just a hint to the OS, and the system could ignore it.

The default is WindowLevel::Normal.

See WindowLevel for details.

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

Sets the window icon.

The default is None.

See Window::set_window_icon for details.

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

Sets a specific theme for the window.

If None is provided, the window will use the system theme.

The default is None.

Platform-specific

• Wayland: This controls only CSD. When using None it’ll try to use dbus to get the system preference. When explicit theme is used, this will avoid dbus all together.
• x11: Build window with _GTK_THEME_VARIANT hint set to dark or light.
• iOS / Android / Web / x11 / Orbital: Ignored.

pub fn with_content_protected(self, protected: bool) -> WindowAttributes

Prevents the window contents from being captured by other apps.

The default is false.

Platform-specific

• macOS: if false, NSWindowSharingNone is used but doesn’t completely prevent all apps from reading the window content, for instance, QuickTime.
• iOS / Android / Web / x11 / Orbital: Ignored.

pub fn with_active(self, active: bool) -> WindowAttributes

Whether the window will be initially focused or not.

The window should be assumed as not focused by default following by the WindowEvent::Focused.

Platform-specific:

Android / iOS / X11 / Wayland / Orbital: Unsupported.

pub fn with_cursor(self, cursor: impl Into<Cursor>) -> WindowAttributes

Modifies the cursor icon of the window.

The default is CursorIcon::Default.

See Window::set_cursor() for more details.

pub unsafe fn with_parent_window( self, parent_window: Option<RawWindowHandle>, ) -> WindowAttributes

Build window with parent window.

The default is None.

Safety

parent_window must be a valid window handle.

Platform-specific

• Windows : A child window has the WS_CHILD style and is confined to the client area of its parent window. For more information, see https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#child-windows
• X11: A child window is confined to the client area of its parent window.
• Android / iOS / Wayland / Web: Unsupported.

Trait Implementations

impl Clone for WindowAttributes

fn clone(&self) -> WindowAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowAttributes

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

Formats the value using the given formatter.

impl Default for WindowAttributes

fn default() -> WindowAttributes

Returns the “default value” for a type.

impl PartialEq for WindowAttributes

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl WindowAttributesExtStartupNotify for WindowAttributes

fn with_activation_token(self, token: ActivationToken) -> WindowAttributes

Use this ActivationToken during window creation.

impl WindowAttributesExtWayland for WindowAttributes

fn with_name( self, general: impl Into<String>, instance: impl Into<String>, ) -> WindowAttributes

Build window with the given name.

impl WindowAttributesExtX11 for WindowAttributes

fn with_x11_visual(self, visual_id: u32) -> WindowAttributes

Create this window with a specific X11 visual.

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

fn with_name( self, general: impl Into<String>, instance: impl Into<String>, ) -> WindowAttributes

Build window with the given general and instance names.

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

Build window with override-redirect flag; defaults to false.

fn with_x11_window_type( self, x11_window_types: Vec<WindowType>, ) -> WindowAttributes

Build window with _NET_WM_WINDOW_TYPE hints; defaults to Normal.

fn with_base_size<S>(self, base_size: S) -> WindowAttributes

where S: Into<Size>,

Build window with base size hint.

fn with_embed_parent_window(self, parent_window_id: u32) -> WindowAttributes

Embed this window into another parent window.

impl StructuralPartialEq for WindowAttributes