Struct epi::Frame

pub struct Frame(pub Arc<Mutex<FrameData>>);

Represents the surroundings of your app.

It provides methods to inspect the surroundings (are we on the web?), allocate textures, and change settings (e.g. window size).

Frame is cheap to clone and is safe to pass to other threads.

Tuple Fields

0: Arc<Mutex<FrameData>>

Implementations

impl Frame

pub fn is_web(&self) -> bool

True if you are in a web environment.

pub fn info(&self) -> IntegrationInfo

Information about the integration.

pub fn quit(&self)

Signal the app to stop/exit/quit the app (only works for native apps, not web apps). The framework will not quit immediately, but at the end of the this frame.

pub fn set_window_size(&self, size: Vec2)

Set the desired inner size of the window (in egui points).

pub fn set_window_title(&self, title: &str)

Set the desired title of the window.

pub fn set_decorations(&self, decorated: bool)

Set whether to show window decorations (i.e. a frame around you app). If false it will be difficult to move and resize the app.

pub fn drag_window(&self)

When called, the native window will follow the movement of the cursor while the primary mouse button is down.

Does not work on the web.

pub fn request_repaint(&self)

This signals the egui integration that a repaint is required.

Call this e.g. when a background process finishes in an async context and/or background thread.

pub fn take_app_output(&self) -> AppOutput

for integrations only: call once per frame

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.