mirror of
https://github.com/emilk/egui.git
synced 2026-07-05 22:37:27 +00:00
Emil Ernerfeldt
8178d23d19
* Move window building to egui-winit * Move icon loading to egui-winit * `use glow::HasContext;` -> `use glow::HasContext as _;` * Move FileStorage into epi behind a feature flag * De-duplicate screen_size_in_pixels and native_pixels_per_point * Move creation of FileStorage to epi * Handle epi app output (window size changes etc) in egui-winit * Move app and memory persistence and autosave logic to egui-winit * fix check.sh * Make the epi backend opt-in for egui_glium and egui_glow * Fix persistence * Add integration name to epi::IntegrationInfo and the demo * Clean up Cargo.toml files and fix making egui_glium optional * fix typo * Make egui_glium compile without the `epi` feature
84 lines
3.3 KiB
Rust
84 lines
3.3 KiB
Rust
//! eframe - the egui framework crate
|
|
//!
|
|
//! If you are planning to write an app for web or native,
|
|
//! and are happy with just using egui for all visuals,
|
|
//! Then `eframe` is for you!
|
|
//!
|
|
//! To get started, look at <https://github.com/emilk/eframe_template>.
|
|
//!
|
|
//! You write your application code for [`epi`] (implementing [`epi::App`]) and then
|
|
//! call from [`crate::run_native`] your `main.rs`, and/or call `eframe::start_web` from your `lib.rs`.
|
|
//!
|
|
//! `eframe` is implemented using [`egui_web`](https://github.com/emilk/egui/tree/master/egui_web) for web and
|
|
//! [`egui_glium`](https://github.com/emilk/egui/tree/master/egui_glium) or [`egui_glow`](https://github.com/emilk/egui/tree/master/egui_glow) for native.
|
|
|
|
// Forbid warnings in release builds:
|
|
#![cfg_attr(not(debug_assertions), deny(warnings))]
|
|
#![forbid(unsafe_code)]
|
|
#![warn(clippy::all, missing_crate_level_docs, missing_docs, rust_2018_idioms)]
|
|
|
|
pub use {egui, epi};
|
|
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
pub use epi::NativeOptions;
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// When compiling for web
|
|
|
|
#[cfg(target_arch = "wasm32")]
|
|
pub use egui_web::wasm_bindgen;
|
|
|
|
/// Install event listeners to register different input events
|
|
/// and start running the given app.
|
|
///
|
|
/// For performance reasons (on some browsers) the egui canvas does not, by default,
|
|
/// fill the whole width of the browser.
|
|
/// This can be changed by overriding [`epi::Frame::max_size_points`].
|
|
///
|
|
/// Usage:
|
|
/// ``` no_run
|
|
/// #[cfg(target_arch = "wasm32")]
|
|
/// use wasm_bindgen::prelude::*;
|
|
///
|
|
/// /// This is the entry-point for all the web-assembly.
|
|
/// /// This is called once from the HTML.
|
|
/// /// It loads the app, installs some callbacks, then returns.
|
|
/// /// You can add more callbacks like this if you want to call in to your code.
|
|
/// #[cfg(target_arch = "wasm32")]
|
|
/// #[wasm_bindgen]
|
|
/// pub fn start(canvas_id: &str) -> Result<(), eframe::wasm_bindgen::JsValue> {
|
|
/// let app = MyEguiApp::default();
|
|
/// eframe::start_web(canvas_id, Box::new(app))
|
|
/// }
|
|
/// ```
|
|
#[cfg(target_arch = "wasm32")]
|
|
pub fn start_web(canvas_id: &str, app: Box<dyn epi::App>) -> Result<(), wasm_bindgen::JsValue> {
|
|
egui_web::start(canvas_id, app)?;
|
|
Ok(())
|
|
}
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// When compiling natively
|
|
|
|
/// Call from `fn main` like this: `eframe::run_native(Box::new(MyEguiApp::default()))`
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
#[cfg(feature = "egui_glium")]
|
|
pub fn run_native(app: Box<dyn epi::App>, native_options: epi::NativeOptions) -> ! {
|
|
egui_glium::run(app, &native_options)
|
|
}
|
|
|
|
/// Call from `fn main` like this: `eframe::run_native(Box::new(MyEguiApp::default()))`
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
#[cfg(not(feature = "egui_glium"))] // make sure we still compile with `--all-features`
|
|
#[cfg(feature = "egui_glow")]
|
|
pub fn run_native(app: Box<dyn epi::App>, native_options: epi::NativeOptions) -> ! {
|
|
egui_glow::run(app, &native_options)
|
|
}
|
|
|
|
// disabled since we want to be able to compile with `--all-features`
|
|
// #[cfg(all(feature = "egui_glium", feature = "egui_glow"))]
|
|
// compile_error!("Enable either egui_glium or egui_glow, not both");
|
|
|
|
#[cfg(not(any(feature = "egui_glium", feature = "egui_glow")))]
|
|
compile_error!("Enable either egui_glium or egui_glow");
|