Struct Application

pub struct Application { /* private fields */ }

Creating a new application creates a root Window and a Context. Views declared within the closure passed to Application::new() are added to the context and rendered into the root window.

Example

Application::new(|cx|{
   // Content goes here
})
.run();

Calling run() on the Application causes the program to enter the event loop and for the main window to display.

Implementations

impl Application

pub fn new<F>(content: F) -> Self

where F: 'static + FnOnce(&mut Context),

pub fn ignore_default_theme(self) -> Self

Sets the default built-in theming to be ignored.

pub fn should_poll(self) -> Self

pub fn on_idle<F: 'static + Fn(&mut Context)>(self, callback: F) -> Self

Takes a closure which will be called at the end of every loop of the application.

The callback provides a place to run ‘idle’ processing and happens at the end of each loop but before drawing. If the callback pushes events into the queue in state then the event loop will re-run. Care must be taken not to push events into the queue every time the callback runs unless this is intended.

Example

Application::new(|cx| {
    // Build application here
})
.on_idle(|cx| {
    // Code here runs at the end of every event loop after OS and vizia events have been handled
})
.run();

pub fn get_proxy(&self) -> ContextProxy

Returns a ContextProxy which can be used to send events from another thread.

pub fn run(self) -> Result<(), ApplicationError>

Trait Implementations

impl ApplicationHandler<UserEvent> for Application

fn user_event(&mut self, _event_loop: &ActiveEventLoop, user_event: UserEvent)

Emitted when an event is sent from EventLoopProxy::send_event.

fn resumed(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has been resumed.

fn window_event( &mut self, _event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent, )

Emitted when the OS sends an event to a winit window.

fn about_to_wait(&mut self, event_loop: &ActiveEventLoop)

Emitted when the event loop is about to block and wait for new events.

fn new_events(&mut self, _event_loop: &ActiveEventLoop, _cause: StartCause)

Emitted when new events arrive from the OS to be processed.

fn exiting(&mut self, _event_loop: &ActiveEventLoop)

Emitted when the event loop is being shut down.

fn device_event( &mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent, )

Emitted when the OS sends an event to a device.

fn suspended(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has been suspended.

fn memory_warning(&mut self, event_loop: &ActiveEventLoop)

Emitted when the application has received a memory warning.

impl WindowModifiers for Application

fn title<T: ToString>(self, title: impl Res<T>) -> Self

Sets the title of the window to the given value. Accepts a type, or lens to a type, which implements ToString.

fn inner_size<S: Into<WindowSize>>(self, size: impl Res<S>) -> Self

Sets the inner size of the window to the given value. Accepts a value, or lens, which can be converted to a [WindowSize].

fn min_inner_size<S: Into<WindowSize>>(self, size: impl Res<Option<S>>) -> Self

Sets the minimum inner size of the window to the given value. Accepts an optional value, or lens, which can be converted to a [WindowSize].

fn max_inner_size<S: Into<WindowSize>>(self, size: impl Res<Option<S>>) -> Self

Sets the maximum inner size of the window to the given value. Accepts an optional value, or lens, which can be converted to a [WindowSize].

fn position<P: Into<WindowPosition>>(self, position: impl Res<P>) -> Self

Sets the position of the window to the given value. Accepts a value, or lens, which can be converted to a [Position].

fn resizable(self, flag: impl Res<bool>) -> Self

Sets whether the window can be resized. Accepts a boolean value, or lens to a boolean value.

fn minimized(self, flag: impl Res<bool>) -> Self

Sets whether the window is minimized. Accepts a boolean value, or lens to a boolean value.

fn maximized(self, flag: impl Res<bool>) -> Self

Sets whether the window is maximized. Accepts a boolean value, or lens to a boolean value.

fn visible(self, flag: impl Res<bool>) -> Self

Sets whether the window is visible. Accepts a boolean value, or lens to a boolean value.

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

Sets whether the window is transparent. Accepts a boolean value, or lens to a boolean value.

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

Sets whether the window has decorations. Accepts a boolean value, or lens to a boolean value.

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

Sets whether the window should be on top of other windows. Accepts a boolean value, or lens to a boolean value.

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

Sets whether the window has vsync enabled.

fn icon(self, width: u32, height: u32, image: Vec<u8>) -> Self

Sets the icon used for the window.

fn on_close(self, _callback: impl Fn(&mut EventContext<'_>)) -> Self

fn on_create(self, _callback: impl Fn(&mut EventContext<'_>)) -> Self

fn enabled_window_buttons(self, window_buttons: WindowButtons) -> Self