Struct epi::Frame

pub struct Frame<'a>(_);

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

Implementations

impl<'a> Frame<'a>

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 tex_allocator(&mut self) -> &mut dyn TextureAllocator

A way to allocate textures.

pub fn quit(&mut 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(&mut self, size: Vec2)

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

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

Set the desired title of the window.

pub fn set_decorations(&mut 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(&mut 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, and works badly on Mac.

pub fn repaint_signal(&self) -> Arc<dyn RepaintSignal>

If you need to request a repaint from another thread, clone this and send it to that other thread.