Struct WindowConfig

pub struct WindowConfig {

    pub app: Arc<dyn Fn() -> Element + Send + Sync>,
    pub size: (f64, f64),
    pub min_size: Option<(f64, f64)>,
    pub max_size: Option<(f64, f64)>,
    pub decorations: bool,
    pub title: &'static str,
    pub transparent: bool,
    pub background: Color,
    pub visible: bool,
    pub icon: Option<Icon>,
    pub on_setup: Option<WindowCallback>,
    pub on_close: Option<OnCloseCallback>,
    pub window_attributes_hook: Option<WindowBuilderHook>,
    pub max_gpu_resources_bytes: Option<usize>,
}

Configuration for a Window.

Fields

app: Arc<dyn Fn() -> Element + Send + Sync>

size: (f64, f64)

Size of the Window.

min_size: Option<(f64, f64)>

Minimum size of the Window.

max_size: Option<(f64, f64)>

Maximum size of the Window.

decorations: bool

Enable Window decorations.

title: &'static str

Title for the Window.

transparent: bool

Make the Window transparent or not.

background: Color

Background color of the Window.

visible: bool

Window visibility. Default to true.

icon: Option<Icon>

The Icon of the Window.

on_setup: Option<WindowCallback>

Setup callback.

on_close: Option<OnCloseCallback>

When window gets a close request.

window_attributes_hook: Option<WindowBuilderHook>

Hook function called with the Window Attributes.

max_gpu_resources_bytes: Option<usize>

Max resource in bytes to be used by the GPU. Defaults to automatic.

Implementations

impl WindowConfig

pub fn new(app: fn() -> Element) -> Self

Create a window with the given app.

pub fn new_with_props<T: Properties + Sync + Send>( app: fn(_: T) -> Element, props: T, ) -> Self

Create a window with the given app and some props to pass to it.

pub fn with_size(self, width: f64, height: f64) -> Self

Specify a Window size.

pub fn with_min_size(self, min_width: f64, min_height: f64) -> Self

Specify a minimum Window size.

pub fn with_max_size(self, max_width: f64, max_height: f64) -> Self

Specify a maximum Window size.

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

Whether the Window will have decorations or not.

pub fn with_title(self, title: &'static str) -> Self

Specify the Window title.

pub fn with_transparency(self, transparency: bool) -> Self

Make the Window transparent or not.

pub fn with_max_gpu_resources_bytes( self, max_gpu_resources_bytes: usize, ) -> Self

Specify the max resources to be cached for the GPU, in bytes.

pub fn with_background(self, background: &str) -> Self

Specify the Window background color.

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

Specify the Window visibility at launch.

pub fn with_icon(self, icon: Icon) -> Self

Specify the Window icon.

pub fn on_setup( self, callback: impl FnOnce(&mut Window) + 'static + Send + Sync, ) -> Self

Register a callback that will be executed when the window is created.

pub fn on_close( self, callback: impl FnOnce(&mut Window) -> OnCloseResponse + 'static + Send + Sync, ) -> Self

Register a callback that will be executed when the window is closed.

pub fn with_window_attributes( self, window_attributes_hook: impl FnOnce(WindowAttributes) -> WindowAttributes + 'static + Send + Sync, ) -> Self

Register a Window Attributes hook.