History

Emil Ernerfeldt e0b5bb17e5 Improve the look of thin lines, making them look weaker (#2437 ) * Revert "fix all clippy lints and remove them from allow list in cranky (#2419)" This reverts commit `930ef2db38`. * Explain the cranky lints better * Add Color32::gamma_multiply * Remove unused pub use * Remove non-existing crate category * Improve color test with more lines * Improve the look of thin lines, making them look weaker Before they looked were too strong for the thickness. * Use asserts for shader compilations * Update changelogs		2022-12-12 16:18:05 +01:00
..
src	Improve the look of thin lines, making them look weaker (#2437 )	2022-12-12 16:18:05 +01:00
Cargo.toml	Make `egui_wgpu::winit::Painter::set_window` async (#2434 )	2022-12-12 15:37:55 +01:00
CHANGELOG.md	eframe error handling (#2433 )	2022-12-12 15:16:32 +01:00
README.md	Fix broken GitHub source links due to #1940	2022-08-20 15:18:02 +02:00

README.md

eframe: the `egui` framework

eframe is the official framework library for writing apps using egui. The app can be compiled both to run natively (cross platform) or be compiled to a web app (using WASM).

To get started, see the examples. To learn how to set up eframe for web and native, go to https://github.com/emilk/eframe_template/ and follow the instructions there!

There is also a tutorial video at https://www.youtube.com/watch?v=NtUkr_z7l84.

For how to use egui, see the egui docs.

eframe uses egui_glow for rendering, and on native it uses egui-winit.

To use on Linux, first run:

sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev

You need to either use edition = "2021", or set resolver = "2" in the [workspace] section of your to-level Cargo.toml. See this link for more info.

You can opt-in to the using egui_wgpu for rendering by enabling the wgpu feature and setting NativeOptions::renderer to Renderer::Wgpu.

Alternatives

eframe is not the only way to write an app using egui! You can also try egui-miniquad, bevy_egui, egui_sdl2_gl, and others.

You can also use egui_glow and winit to build your own app as demonstrated in https://github.com/emilk/egui/blob/master/crates/egui_glow/examples/pure_glow.rs.

Problems with running egui on the web

eframe uses WebGL (via glow) and WASM, and almost nothing else from the web tech stack. This has some benefits, but also produces some challenges and serious downsides.

Rendering: Getting pixel-perfect rendering right on the web is very difficult.
Search: you cannot search an egui web page like you would a normal web page.
Bringing up an on-screen keyboard on mobile: there is no JS function to do this, so eframe fakes it by adding some invisible DOM elements. It doesn't always work.
Mobile text editing is not as good as for a normal web app.
Accessibility: There is an experimental screen reader for eframe, but it has to be enabled explicitly. There is no JS function to ask "Does the user want a screen reader?" (and there should probably not be such a function, due to user tracking/integrity concerns).
No integration with browser settings for colors and fonts.
On Linux and Mac, Firefox will copy the WebGL render target from GPU, to CPU and then back again (https://bugzilla.mozilla.org/show_bug.cgi?id=1010527#c0), slowing down egui.

In many ways, eframe is trying to make the browser do something it wasn't designed to do (though there are many things browser vendors could do to improve how well libraries like egui work).

The suggested use for eframe are for web apps where performance and responsiveness are more important than accessibility and mobile text editing.

Companion crates

Not all rust crates work when compiled to WASM, but here are some useful crates have been designed to work well both natively and as WASM:

Audio: cpal.
HTTP client: ehttp and reqwest.
Time: chrono.
WebSockets: ewebsock.

Name

The frame in eframe stands both for the frame in which your egui app resides and also for "framework" (frame is a framework, egui is a library).