1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
//! Traits and helper for writing Egui apps. //! //! This module is very experimental, and you don't need to use it. //! //! Egui can be used as a library, but you can also use it as a framework to write apps in. //! This module defined the `App` trait that can be implemented and used with the `egui_web` and `egui_glium` crates. // TODO: move egui/src/app.rs to own crate, e.g. egui_framework ? use crate::Ui; /// Implement this trait to write apps that can be compiled both natively using the [`egui_glium`](https://crates.io/crates/egui_glium) crate, /// and deployed as a web site using the [`egui_web`](https://crates.io/crates/egui_web) crate. pub trait App { /// Called each time the UI needs repainting, which may be many times per second. fn ui(&mut self, ui: &mut Ui, backend: &mut dyn Backend); /// Called once on shutdown. Allows you to save state. fn on_exit(&mut self, _storage: &mut dyn Storage) {} } pub struct WebInfo { /// e.g. "#fragment" part of "www.example.com/index.html#fragment" pub web_location_hash: String, } pub trait Backend { /// If the app is running in a Web context, this returns information about the environment. fn web_info(&self) -> Option<WebInfo> { None } /// Seconds of cpu usage (in seconds) of UI code on the previous frame. /// Zero if this is the first frame. fn cpu_usage(&self) -> Option<f32>; /// Local time. Used for the clock in the demo app. fn seconds_since_midnight(&self) -> Option<f64> { None } /// Signal the backend that we'd like to exit the app now. /// This does nothing for web apps. fn quit(&mut self) {} /// Allocate a user texture (EXPERIMENTAL!) fn new_texture_srgba_premultiplied( &mut self, size: (usize, usize), pixels: &[crate::Srgba], ) -> crate::TextureId; } /// A place where you can store custom data in a way that persists when you restart the app. /// /// On the web this is backed by [local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage). /// On desktop this is backed by the file system. pub trait Storage { fn get_string(&self, key: &str) -> Option<&str>; fn set_string(&mut self, key: &str, value: String); } #[cfg(feature = "serde_json")] pub fn get_value<T: serde::de::DeserializeOwned>(storage: &dyn Storage, key: &str) -> Option<T> { storage .get_string(key) .and_then(|value| serde_json::from_str(value).ok()) } #[cfg(feature = "serde_json")] pub fn set_value<T: serde::Serialize>(storage: &mut dyn Storage, key: &str, value: &T) { storage.set_string(key, serde_json::to_string(value).unwrap()); } /// storage key used for app pub const APP_KEY: &str = "app";