#wasm #web #egui #gui #gamedev

egui_web

Bindings for compiling egui code to WASM for a web page

13 breaking releases

0.14.1 Aug 28, 2021
0.13.0 Jun 24, 2021
0.10.0 Feb 28, 2021
0.6.0 Dec 26, 2020
0.4.0 Nov 28, 2020

#96 in Web programming

Download history 499/week @ 2021-06-30 439/week @ 2021-07-07 417/week @ 2021-07-14 542/week @ 2021-07-21 799/week @ 2021-07-28 639/week @ 2021-08-04 588/week @ 2021-08-11 458/week @ 2021-08-18 588/week @ 2021-08-25 581/week @ 2021-09-01 976/week @ 2021-09-08 804/week @ 2021-09-15 712/week @ 2021-09-22 679/week @ 2021-09-29 687/week @ 2021-10-06 847/week @ 2021-10-13

2,037 downloads per month
Used in 8 crates (via eframe)

MIT/Apache and maybe LGPL-2.1

1MB
19K SLoC

egui_web

Latest version Documentation unsafe forbidden MIT Apache

This crates allows you to compile GUI code written with egui to WASM to run on a web page.

Run the web demo to try it now.

Check out egui_template for an example of how to set it up.

Downsides with using egui on the web

egui_web uses WebGL and WASM, and almost nothing else from the web tech stack. This has some benefits, but also produces some challanges and serious downsides.

  • Rendering: Getting pixel-perfect rendering right on the web is very difficult, leading to text that is hard to read on low-DPI screens (https://github.com/emilk/egui/issues/516). Additonally, WebGL does not support linear framebuffer blending.
  • Search: you cannot search a 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 egui_web 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 egui_web, 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 conserns).
  • 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.

The suggested use for egui_web is for experiments, personal projects and web games. Using egui for a serious web page is probably a bad idea.

In many ways, egui_web 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).

Dependencies

~8–11MB
~210K SLoC