Struct WindowOptions 

pub struct WindowOptions {

    pub window_bounds: Option<WindowBounds>,
    pub titlebar: Option<TitlebarOptions>,
    pub focus: bool,
    pub show: bool,
    pub kind: WindowKind,
    pub is_movable: bool,
    pub app_owns_titlebar_drag: bool,
    pub inactive_frame_interval: Option<Duration>,
    pub is_resizable: bool,
    pub is_minimizable: bool,
    pub display_id: Option<DisplayId>,
    pub linux_window_background: LinuxWindowBackground,
    pub app_id: Option<String>,
    pub window_min_size: Option<Size<Pixels>>,
    pub window_decorations: Option<WindowDecorations>,
    pub icon: Option<Arc<RgbaImage>>,
    pub tabbing_identifier: Option<String>,
    pub use_display_p3: bool,
}

Options for creating a window, passed to App::open_window.

Start from WindowOptions::default (or WindowOptions::new, which is the same) and chain setters for the fields you want to change. Each setter takes the value itself, or an Option to clear the field. The defaults give a focused, shown, resizable, movable normal window with a titlebar, at the platform’s default size and position.

Not every platform reads every field. The web backend uses WindowOptions::kind, WindowOptions::show, and web_window_background. The page’s canvas is the window, so bounds, the titlebar, the minimum size and the resize options are ignored. Each field’s docs say which platforms use it. See platforms.

Examples

Start from the defaults and change only what you need:

use gpui::{Bounds, WindowBounds, WindowOptions, point, px, size};

let bounds = Bounds::new(point(px(100.), px(100.)), size(px(800.), px(600.)));
let options = WindowOptions::default()
    .window_bounds(WindowBounds::Windowed(bounds))
    .is_resizable(false)
    .titlebar(None);

assert_eq!(options.window_bounds, Some(WindowBounds::Windowed(bounds)));
assert!(!options.is_resizable);
assert!(options.titlebar.is_none());
assert!(options.focus);

Create a window that doesn’t take focus and opens hidden, so you can show it later:

use gpui::WindowOptions;

let options = WindowOptions::new().focus(false).show(false);

assert!(!options.focus);
assert!(!options.show);

Fields

window_bounds: Option<WindowBounds>

The window’s state and bounds in screen coordinates, in logical pixels.

None inherits the bounds from the platform, and Some opens the window in the given state. A Windowed window opens at the rectangle, and Maximized and Fullscreen restore to the rectangle when left. Ignored on the web.

titlebar: Option<TitlebarOptions>

The titlebar, or None for a window without one. Ignored on the web.

The default is TitlebarOptions::default, which shows the platform’s titlebar with no title.

focus: bool

Whether the window takes keyboard focus when it opens. Defaults to true.

show: bool

Whether the window appears when it opens. Set it to false to show the window later with PlatformWindow::set_visible.

kind: WindowKind

The kind of window to create. Defaults to WindowKind::Normal. On the web, only Normal works.

is_movable: bool

Whether the user can drag the window. Defaults to true. macOS and Windows use this value. Linux and the web ignore it. Programmatic moves still work.

app_owns_titlebar_drag: bool

Whether the application owns dragging of the (custom) titlebar, rather than AppKit. Only has an effect on macOS.

Set this to true for windows that draw their own titlebar and move the window themselves via Window::start_window_move. It marks the whole content view as app-owned titlebar content, so AppKit neither drags the window from the titlebar nor delays titlebar clicks while disambiguating double-clicks (a delay first observed on macOS 27). It is independent of is_movable, so such windows stay user-movable (via their own drag) and keep the Window-menu tiling items enabled.

Leave this false for windows that rely on AppKit’s native titlebar dragging.

inactive_frame_interval: Option<Duration>

The minimum time between animation frames while the window is inactive.

Defaults to about 30 frames per second. Set None to draw inactive windows at the full frame rate.

is_resizable: bool

Whether the user can resize the window. Defaults to true. Ignored on the web.

is_minimizable: bool

Whether the user can minimize the window. Defaults to true. Ignored on the web.

display_id: Option<DisplayId>

The display to open the window on, or None for the primary display. Ignored on the web.

linux_window_background: LinuxWindowBackground

The background appearance of a Linux window.

app_id: Option<String>

The application id that desktop environments use to group windows and find the desktop entry.

Linux only. Other platforms ignore it.

window_min_size: Option<Size<Pixels>>

The smallest size the user can resize the window to, in logical pixels. None sets no minimum. Ignored on the web.

window_decorations: Option<WindowDecorations>

Whether the window draws its own decorations (client-side) or the window server does (server-side).

None uses the server’s default. Linux’s Wayland and X11 backends honor it, and the other backends ignore it. The platform may ignore requests it can’t satisfy.

icon: Option<Arc<RgbaImage>>

The window’s icon, from an RGBA image. Linux only, and Wayland needs the xdg-toplevel-icon protocol to show it.

tabbing_identifier: Option<String>

The name of the native tab group. Windows with the same identifier open as tabs of one window. macOS only.

use_display_p3: bool

Whether to render the window using the Display P3 color space on macOS.

Implementations

impl WindowOptions

pub fn window_bounds(self, value: impl Into<Option<WindowBounds>>) -> Self

Sets the window_bounds field of this struct.

pub fn titlebar(self, value: impl Into<Option<TitlebarOptions>>) -> Self

Sets the titlebar field of this struct.

pub fn focus(self, value: impl Into<bool>) -> Self

Sets the focus field of this struct.

pub fn show(self, value: impl Into<bool>) -> Self

Sets the show field of this struct.

pub fn kind(self, value: impl Into<WindowKind>) -> Self

Sets the kind field of this struct.

pub fn is_movable(self, value: impl Into<bool>) -> Self

Sets the is_movable field of this struct.

pub fn app_owns_titlebar_drag(self, value: impl Into<bool>) -> Self

Sets the app_owns_titlebar_drag field of this struct.

pub fn inactive_frame_interval(self, value: impl Into<Option<Duration>>) -> Self

Sets the inactive_frame_interval field of this struct.

pub fn is_resizable(self, value: impl Into<bool>) -> Self

Sets the is_resizable field of this struct.

pub fn is_minimizable(self, value: impl Into<bool>) -> Self

Sets the is_minimizable field of this struct.

pub fn display_id(self, value: impl Into<Option<DisplayId>>) -> Self

Sets the display_id field of this struct.

pub fn linux_window_background( self, value: impl Into<LinuxWindowBackground>, ) -> Self

Sets the linux_window_background field of this struct.

pub fn app_id(self, value: impl Into<Option<String>>) -> Self

Sets the app_id field of this struct.

pub fn window_min_size(self, value: impl Into<Option<Size<Pixels>>>) -> Self

Sets the window_min_size field of this struct.

pub fn window_decorations( self, value: impl Into<Option<WindowDecorations>>, ) -> Self

Sets the window_decorations field of this struct.

pub fn icon(self, value: impl Into<Option<Arc<RgbaImage>>>) -> Self

Sets the icon field of this struct.

pub fn tabbing_identifier(self, value: impl Into<Option<String>>) -> Self

Sets the tabbing_identifier field of this struct.

pub fn use_display_p3(self, value: impl Into<bool>) -> Self

Sets the use_display_p3 field of this struct.

impl WindowOptions

pub fn new() -> Self

Returns window options with the platform’s defaults: a focused, shown, resizable, minimizable, movable normal window with a titlebar.

pub fn background_appearance(&self) -> WindowBackgroundAppearance

Returns the window’s background appearance for the current platform, erased into the renderer-facing WindowBackgroundAppearance.

Trait Implementations

impl Debug for WindowOptions

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

Formats the value using the given formatter.

impl Default for WindowOptions

fn default() -> Self

Returns the “default value” for a type.

impl FluentBuilder for WindowOptions

fn map<U>(self, f: impl FnOnce(Self) -> U) -> U

where Self: Sized,

Passes self to f, and returns the result. Use it to continue a chain with a closure.

fn when(self, condition: bool, then: impl FnOnce(Self) -> Self) -> Self

where Self: Sized,

Calls then with self if condition is true. Otherwise returns self unchanged.

fn when_else( self, condition: bool, then: impl FnOnce(Self) -> Self, else_fn: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Calls then with self if condition is true, and else_fn with self otherwise.

fn when_some<T>( self, option: Option<T>, then: impl FnOnce(Self, T) -> Self, ) -> Self

where Self: Sized,

Calls then with self and the value inside option if the option is Some. Returns self unchanged for None.

fn when_none<T>( self, option: &Option<T>, then: impl FnOnce(Self) -> Self, ) -> Self

where Self: Sized,

Calls then with self if option is None. The option is taken by reference, so you can still use it afterward.