|0.20.1||Dec 11, 2022|
|0.19.0||Aug 20, 2022|
|0.18.0||Apr 30, 2022|
|0.17.0||Feb 22, 2022|
|0.10.0||Feb 28, 2021|
#12 in Game dev
25,260 downloads per month
Used in 85 crates (81 directly)
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).
There is also a tutorial video at https://www.youtube.com/watch?v=NtUkr_z7l84.
For how to use
egui, see the egui docs.
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
You can also use
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
eframefakes 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.
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:
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).