egui/ARCHITECTURE.md

# Architecture
This document describes how the crates that make up egui are all connected.

Also see [`CONTRIBUTING.md`](CONTRIBUTING.md) for what to do before opening a PR.


## Crate overview
The crates in this repository are: `egui, emath, epaint, egui_extras, egui_plot, egui-winit, egui_glow, egui_demo_lib, egui_demo_app`.

### `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 }`

Depends on `emath`.

### `egui_extras`
This adds additional features on top of `egui`.

### `egui_plot`
Plotting for `egui`.

### `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.

### `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).

### `eframe`
`eframe` is the official `egui` framework, built so you can compile the same app for either web or native.

The demo that you can see at <https://www.egui.rs> is using `eframe` to host the `egui`. The demo code is found in:

### `egui_demo_lib`
Depends on `egui`.
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>.
fix typo in architecture.md (#2123) 2022-10-10 15:42:50 +08:00			`# Architecture`
Improve documentation 2021-02-21 17:12:08 +08:00			`This document describes how the crates that make up egui are all connected.`

Update accesskit to 0.11 (#3012) * Update accesskit to 0.11 * Add instructions on how to test the web viewer to CONTRIBUTING.md Also removed dependency on `jq` Closes https://github.com/emilk/egui/issues/2859 2023-05-23 01:20:58 +08:00			Also see [`CONTRIBUTING.md`](CONTRIBUTING.md) for what to do before opening a PR.
Improve documentation 2021-02-21 17:12:08 +08:00

			`## Crate overview`
Taking over egui_glium (#3535) Hello. I would like to maintain egui_glium. I have already updated my fork to the newest version of glium. You can find it at: https://github.com/fayalalebrun/egui_glium Let me know about next steps regarding access to crates.io. <!-- Please read the "Making a PR" section of [`CONTRIBUTING.md`](https://github.com/emilk/egui/blob/master/CONTRIBUTING.md) before opening a Pull Request! * Keep your PR:s small and focused. * If applicable, add a screenshot or gif. * If it is a non-trivial addition, consider adding a demo for it to `egui_demo_lib`, or a new example. * Do NOT open PR:s from your `master` branch, as that makes it hard for maintainers to add commits to your PR. * Remember to run `cargo fmt` and `cargo cranky`. * Open the PR as a draft until you have self-reviewed it and run `./scripts/check.sh`. * When you have addressed a PR comment, mark it as resolved. Please be patient! I will review you PR, but my time is limited! --> 2023-11-12 01:35:57 +08:00			The crates in this repository are: `egui, emath, epaint, egui_extras, egui_plot, egui-winit, 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 }`

Remove the single_threaded/multi_threaded feature flags (#1390) Always use parking_lot for mutexes, i.e. always be multi-threaded. Closes #1379 2022-03-22 05:20:37 +08:00			Depends on `emath`.
Improve documentation 2021-02-21 17:12:08 +08:00
Introduce egui_extras with RetainedImage for loading svg,png,jpeg,… (#1282) 2022-02-21 22:26:26 +08:00			### `egui_extras`
			This adds additional features on top of `egui`.

Break out plotting to own crate `egui_plot` (#3282) This replaces `egui::plot` with the new crate `egui_plot` 2023-08-27 23:22:49 +08:00			### `egui_plot`
			Plotting for `egui`.

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.`

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`
Remove `egui_web` and `epi` (#1545) * Remove integration name (it is always eframe) * Remove egui_web crate * Move egui_web/CHANGELOG.md into eframe/CHANGELOG.md * Remove all mentions of egui_web * Remove epi crate and absorb into eframe * egui_glow: only use puffin on native * Remove WASM doc from CI (we don't generate it anyways!) * Remove eframe::epi and improve eframe docs 2022-04-30 16:44:35 +08:00			`eframe` is the official `egui` framework, built so you can compile the same app for either web or native.
Improve documentation 2021-02-21 17:12:08 +08:00
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`
Remove `egui_web` and `epi` (#1545) * Remove integration name (it is always eframe) * Remove egui_web crate * Move egui_web/CHANGELOG.md into eframe/CHANGELOG.md * Remove all mentions of egui_web * Remove epi crate and absorb into eframe * egui_glow: only use puffin on native * Remove WASM doc from CI (we don't generate it anyways!) * Remove eframe::epi and improve eframe docs 2022-04-30 16:44:35 +08:00			Depends on `egui`.
Improve documentation 2021-02-21 17:12:08 +08:00			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>.