Struct ToolFrame

pub struct ToolFrame { /* private fields */ }

A ‘ToolFrame’ is a egui App that provides a basic Menu bar, Bottom Status Bar, and pre-fills it with some utilities like the Style UI, and rendering statistics.

Purpose is to reduce the amount of duplicated code across multiple tools.

Implementations

impl ToolFrame

pub fn new(_cc: &CreationContext<'_>, child: Box<dyn ToolApp>) -> Self

pub fn new_opts( _cc: &CreationContext<'_>, child: Box<dyn ToolApp>, opts: ToolFrameOptions, ) -> Self

pub fn show_rendering_stats(&mut self, show: bool)

pub fn full_speed(&mut self, full_speed: bool)

Trait Implementations

impl App for ToolFrame

fn update(&mut self, ctx: &Context, frame: &mut Frame)

Called each time the UI needs repainting, which may be many times per second.

fn save(&mut self, _storage: &mut dyn Storage)

Called on shutdown, and perhaps at regular intervals. Allows you to save state.

fn on_exit(&mut self)

Called once on shutdown, after Self::save.

fn auto_save_interval(&self) -> Duration

Time between automatic calls to Self::save

fn clear_color(&self, _visuals: &Visuals) -> [f32; 4]

Background color values for the app, e.g. what is sent to gl.clearColor.

fn persist_egui_memory(&self) -> bool

Controls whether or not the egui memory (window positions etc) will be persisted (only if the “persistence” feature is enabled).

fn raw_input_hook(&mut self, _ctx: &Context, _raw_input: &mut RawInput)

A hook for manipulating or filtering raw input before it is processed by Self::update.