dnrops
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
egui/ARCHITECTURE.md

58 lines
2.6 KiB
Markdown
Raw Normal View History

Improve documentation
2021-02-21 17:12:08 +08:00
# Arcitecture
This document describes how the crates that make up egui are all connected.
Improve documentation for the most common widgets
2021-02-24 05:18:13 +08:00
Also see [`CONTRIBUTING.md`](https://github.com/emilk/egui/blob/master/CONTRIBUTING.md) for what to do before opening a PR.
Improve documentation
2021-02-21 17:12:08 +08:00
## Crate overview
Add egui_glow as an opt-in backend to eframe (#817) * Make egui_glow and opt-in backend for eframe * Add egui_glow to Cargo.toml and to CI * Reference egui_glow where egui_glium is mentioned * Remove path-patches from root Cargo.toml * Add instructions on how to enable the glow backend of eframe
2021-10-19 21:32:23 +08:00
The crates in this repository are: `egui, emath, epaint, egui, epi, egui-winit, egui_web, egui_glium, egui_glow, egui_demo_lib, egui_demo_app`.
Improve documentation
2021-02-21 17:12:08 +08:00
### `egui`: The main GUI library.
Example code: `if ui.button("Click me").clicked() { … }`
This is the crate where the bulk of the code is at. `egui` depends only on `emath` and `epaint`.
### `emath`: minimal 2D math library
Examples: `Vec2, Pos2, Rect, lerp, remap`
### `epaint`
2d shapes and text that can be turned into textured triangles.
Example: `Shape::Circle { center, radius, fill, stroke }`
Use ab_glyph instead of rusttype for font rendering (#490) * Use ab_glyph instead of rusttype for font rendering * address review feedback
2021-06-24 18:13:57 +08:00
Depends on `emath`, [`ab_glyph`](https://crates.io/crates/ab_glyph), [`atomic_refcell`](https://crates.io/crates/atomic_refcell), [`ahash`](https://crates.io/crates/ahash).
Improve documentation
2021-02-21 17:12:08 +08:00
### `epi`
Depends only on `egui`.
Adds a thin application level wrapper around `egui` for hosting an `egui` app inside of `eframe`.
Split out new crate egui-winit from egui_glium (#735)
2021-09-28 23:33:28 +08:00
### `egui-winit`
This crates provides bindings between [`egui`](https://github.com/emilk/egui) and [winit](https://crates.io/crates/winit).
The library translates winit events to egui, handled copy/paste, updates the cursor, open links clicked in egui, etc.
Improve documentation
2021-02-21 17:12:08 +08:00
### `egui_web`
Puts an egui app inside the web browser by compiling to WASM and binding to the web browser with [`js-sys`](https://crates.io/crates/js-sys) and [`wasm-bindgen`](https://crates.io/crates/wasm-bindgen). Paints the triangles that egui outputs using WebGL.
### `egui_glium`
Puts an egui app inside a native window on your laptop. Paints the triangles that egui outputs using [glium](https://github.com/glium/glium).
Add egui_glow backend as alternative to egui_glium (#685)
2021-10-19 05:13:32 +08:00
### `egui_glow`
Puts an egui app inside a native window on your laptop. Paints the triangles that egui outputs using [glow](https://github.com/grovesNL/glow).
Improve documentation
2021-02-21 17:12:08 +08:00
### `eframe`
A wrapper around `egui_web` + `egui_glium`, so you can compile the same app for either web or native.
emilk.github.io -> www.egui.rs
2022-01-31 05:01:33 +08:00
The demo that you can see at <https://www.egui.rs> is using `eframe` to host the `egui`. The demo code is found in:
Improve documentation
2021-02-21 17:12:08 +08:00
### `egui_demo_lib`
Depends on `egui` + `epi`.
This contains a bunch of uses of `egui` and looks like the ui code you would write for an `egui` app.
### `egui_demo_app`
Thin wrapper around `egui_demo_lib` so we can compile it to a web site or a native app executable.
Depends on `egui_demo_lib` + `eframe`.
### Other integrations
There are also many great integrations for game engines such as `bevy` and `miniquad` which you can find at <https://github.com/emilk/egui#integrations>.