Struct WindowAttributes

pub struct WindowAttributes {

    pub inner_size: Option<Size>,
    pub min_inner_size: Option<Size>,
    pub max_inner_size: 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 resize_increments: Option<Size>,
    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

inner_size: Option<Size>

min_inner_size: Option<Size>

max_inner_size: 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>

resize_increments: Option<Size>

content_protected: bool

window_level: WindowLevel

active: bool

cursor: Cursor

fullscreen: Option<Fullscreen>

Implementations

impl WindowAttributes

pub fn new() -> Self

👎Deprecated: use Window::default_attributes instead

Initializes new attributes with default values.

impl WindowAttributes

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

Available on crate feature rwh_06 only.

Get the parent window stored on the attributes.

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

Requests the window to be of specific dimensions.

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

See Window::request_inner_size for details.

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

Sets the minimum dimensions a window can have.

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

See Window::set_min_inner_size for details.

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

Sets the maximum dimensions a window can have.

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

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.

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 inner_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) -> Self

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) -> Self

Sets the enabled window buttons.

The default is WindowButtons::all

See Window::set_enabled_buttons for details.

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

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>) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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) -> Self

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>) -> Self

Sets the window icon.

The default is None.

See Window::set_window_icon for details.

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

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_resize_increments<S: Into<Size>>(self, resize_increments: S) -> Self

Build window with resize increments hint.

The default is None.

See Window::set_resize_increments for details.

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

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) -> Self

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>) -> Self

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>, ) -> Self

Available on crate feature rwh_06 only.

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

Formats the value using the given formatter.

impl Default for WindowAttributes

fn default() -> WindowAttributes

Returns the “default value” for a type.

impl WindowAttributesExtIOS for WindowAttributes

Available on ios_platform only.

fn with_scale_factor(self, scale_factor: f64) -> Self

Sets the contentScaleFactor of the underlying UIWindow to scale_factor.

fn with_valid_orientations(self, valid_orientations: ValidOrientations) -> Self

Sets the valid orientations for the Window.

fn with_prefers_home_indicator_hidden(self, hidden: bool) -> Self

Sets whether the Window prefers the home indicator hidden.

fn with_preferred_screen_edges_deferring_system_gestures( self, edges: ScreenEdge, ) -> Self

Sets the screen edges for which the system gestures will take a lower priority than the application’s touch handling.

fn with_prefers_status_bar_hidden(self, hidden: bool) -> Self

Sets whether the Window prefers the status bar hidden.

fn with_preferred_status_bar_style( self, status_bar_style: StatusBarStyle, ) -> Self

Sets the style of the Window’s status bar.

impl WindowAttributesExtMacOS for WindowAttributes

Available on macos_platform only.

fn with_movable_by_window_background( self, movable_by_window_background: bool, ) -> Self

Enables click-and-drag behavior for the entire window, not just the titlebar.

fn with_titlebar_transparent(self, titlebar_transparent: bool) -> Self

Makes the titlebar transparent and allows the content to appear behind it.

fn with_titlebar_hidden(self, titlebar_hidden: bool) -> Self

Hides the window titlebar.

fn with_titlebar_buttons_hidden(self, titlebar_buttons_hidden: bool) -> Self

Hides the window titlebar buttons.

fn with_title_hidden(self, title_hidden: bool) -> Self

Hides the window title.

fn with_fullsize_content_view(self, fullsize_content_view: bool) -> Self

Makes the window content appear behind the titlebar.

fn with_disallow_hidpi(self, disallow_hidpi: bool) -> Self

fn with_has_shadow(self, has_shadow: bool) -> Self

fn with_accepts_first_mouse(self, accepts_first_mouse: bool) -> Self

Window accepts click-through mouse events.

fn with_tabbing_identifier(self, tabbing_identifier: &str) -> Self

Defines the window tabbing identifier.

fn with_option_as_alt(self, option_as_alt: OptionAsAlt) -> Self

Set how the Option keys are interpreted.

fn with_borderless_game(self, borderless_game: bool) -> Self

See WindowExtMacOS::set_borderless_game for details on what this means if set.

impl WindowAttributesExtStartupNotify for WindowAttributes

Available on x11_platform or wayland_platform only.

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

Use this ActivationToken during window creation.

impl WindowAttributesExtWayland for WindowAttributes

Available on wayland_platform only.

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

Build window with the given name.

impl WindowAttributesExtWebSys for WindowAttributes

Available on web_platform only.

fn with_canvas(self, canvas: Option<HtmlCanvasElement>) -> Self

Pass an HtmlCanvasElement to be used for this Window. If None, WindowAttributes::default() will create one.

fn with_prevent_default(self, prevent_default: bool) -> Self

Sets whether event.preventDefault() should be called on events on the canvas that have side effects.

fn with_focusable(self, focusable: bool) -> Self

Whether the canvas should be focusable using the tab key. This is necessary to capture canvas keyboard events.

fn with_append(self, append: bool) -> Self

On window creation, append the canvas element to the web page if it isn’t already.

impl WindowAttributesExtWindows for WindowAttributes

Available on windows_platform only.

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

Set an owner to the window to be created. Can be used to create a dialog box, for example. This only works when WindowAttributes::with_parent_window isn’t called or set to None. 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) -> Self

Sets a menu on the window to be created.

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

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

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

This sets WS_EX_NOREDIRECTIONBITMAP.

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

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_skip_taskbar(self, skip: bool) -> Self

Whether show or hide the window icon in the taskbar.

fn with_class_name<S: Into<String>>(self, class_name: S) -> Self

Customize the window class name.

fn with_undecorated_shadow(self, shadow: bool) -> Self

Shows or hides the background drop shadow for undecorated windows.

fn with_system_backdrop(self, backdrop_type: BackdropType) -> Self

Sets system-drawn backdrop type.

fn with_clip_children(self, flag: bool) -> Self

This sets or removes WS_CLIPCHILDREN style.

fn with_border_color(self, color: Option<Color>) -> Self

Sets the color of the window border.

fn with_title_background_color(self, color: Option<Color>) -> Self

Sets the background color of the title bar.

fn with_title_text_color(self, color: Color) -> Self

Sets the color of the window title.

fn with_corner_preference(self, corners: CornerPreference) -> Self

Sets the preferred style of the window corners.

impl WindowAttributesExtX11 for WindowAttributes

Available on x11_platform only.

fn with_x11_visual(self, visual_id: XVisualID) -> Self

Create this window with a specific X11 visual.

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

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

Build window with the given general and instance names.

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

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

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

Build window with _NET_WM_WINDOW_TYPE hints; defaults to Normal.

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

Build window with base size hint.

fn with_embed_parent_window(self, parent_window_id: XWindow) -> Self

Embed this window into another parent window.

impl WindowAttributesExtAndroid for WindowAttributes

Available on android_platform only.