migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-09-01 06:10:06 -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

13
epi/src/lib.rs
View File

@@ -1,13 +1,10 @@
//! Backend-agnostic interface for writing apps using [`egui`].
//!
//! [`egui`] is a GUI library, which can be plugged in to e.g. a game engine.
//! `epi` provides interfaces for window management, serialization and http requests.
//! An app written for `epi` can then be plugged into [`eframe`](https://docs.rs/eframe),
//! the Egui framework crate.
//!
//! Start by looking at the [`App`] trait, and implement [`App::ui`].
//!
//! 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`.
//!
//! This crate is primarily used by the `egui_web` and `egui_glium` crates.
//! Start by looking at the [`App`] trait, and implement [`App::update`].
#![cfg_attr(not(debug_assertions), deny(warnings))] // Forbid warnings in release builds
#![forbid(unsafe_code)]
@@ -329,7 +326,7 @@ pub mod backend {
}
impl<'a> FrameBuilder<'a> {
/// Wrap us in a [`Frame`] to send to [`App::ui`].
/// Wrap us in a [`Frame`] to send to [`App::update`].
pub fn build(self) -> Frame<'a> {
Frame(self)
}