migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-08-31 22:00:03 -04:00
Code Activity

Improve ecosystem documentation and add changelogs for epi and eframe

Browse Source
This commit is contained in:
Emil Ernerfeldt
2021-01-02 11:59:20 +01:00
parent b3d1016507
commit 4e3251c300
10 changed files with 52 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
eframe/CHANGELOG.md Normal file
View File

@@ -0,0 +1,10 @@
# Changelog for eframe
All notable changes to the `eframe` crate.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
## Unreleased
* Initial release of eframe

4
eframe/README.md
View File

@@ -2,6 +2,6 @@
This aims to be the entry-level crate if you want to write an Egui App.
`eframe` calls into your code (it is a framework) and supports web apps (via `egui_web`) and native apps (via `egui_glium`).
`eframe` calls into your code (it is a framework) and supports web apps (via [`egui_web`](https://crates.io/crates/egui_web)) and native apps (via [`egui_glium`](https://crates.io/crates/egui_glium)).
`eframe` is a very thin crate that re-exports `egui`, `epi` and thin wrappers over the backends.
`eframe` is a very thin crate that re-exports [`egui`](https://crates.io/crates/egui), [`epi`](https://crates.io/crates/epi) and thin wrappers over the backends.

14
eframe/src/lib.rs
View File

@@ -1,11 +1,11 @@
//! Backend-agnostic interface for writing apps using Egui.
//! eframe - the Egui Framework crate
//!
//! Egui is a GUI library, which can be plugged in to e.g. a game engine.
//! You write your application code for [`epi`] (implementing [`epi::App`]) and then
//! use eframe to either compile and run it natively, or compile it as a web app.
//!
//! This crate provides a common interface for programming an app, using Egui,
//! so you can then easily plug it in to a backend such as `egui_web` or `egui_glium`.
//! To get started, look at <https://github.com/emilk/egui_template>.
//!
//! This crate is primarily used by the `egui_web` and `egui_glium` crates.
//! eframe is implemented using [`egui_web`](https://docs.rs/egui_web) and [`egui_glium`](https://docs.rs/egui_glium).
#![forbid(unsafe_code)]
#![cfg_attr(not(debug_assertions), deny(warnings))] // Forbid warnings in release builds
@@ -47,8 +47,8 @@ pub fn start_web(canvas_id: &str, app: Box<dyn epi::App>) -> Result<(), wasm_bin
// ----------------------------------------------------------------------------
// When compiling natively
/// Call from main as `eframe::run_native(Box::new(MyEguiApp::default()))`
/// Call from `fn main` like this: `eframe::run_native(Box::new(MyEguiApp::default()))`
#[cfg(not(target_arch = "wasm32"))]
pub fn run_native(app: Box<dyn epi::App>) {
pub fn run_native(app: Box<dyn epi::App>) -> ! {
egui_glium::run(app)
}