Split out new crate egui-winit from egui_glium #735

emilk · 2021-09-22T21:43:13Z

This extracts a lot of code from egui_glium into a reusable crate ~~egui_for_winit~~ egui-winit. This can be reused for egui_glow (#685) and many other integrations.

This replaces the 3rd party egui_winit_platform which is used by a few integrations: https://crates.io/crates/egui_winit_platform/reverse_dependencies. egui_for_winit handles a lot more things, like touch input, screen reader, etc.

~~The name egui_for_winit is not great, but egui_winit was already taken. I would welcome a better name suggestion!~~

API

emilk · 2021-09-22T21:59:46Z

@hasenbanck @LU15W1R7H @parasyte @derivator @t18b219k @Gui-Yom - You may be interested in this, and have feedback on the API?

luiswirth · 2021-09-22T22:07:35Z

I'll take a look in the next days.

Since I own the egui-winit name, we can discuss a transfer of it, if you're interested.

AlexApps99 · 2021-09-22T22:41:45Z

What about egui_base? Might be a bit generic though

AlexApps99

Just some trivial typos, I'll test the code later today if I can

README.md

egui_for_winit/README.md

ARCHITECTURE.md

KentaTheBugMaker · 2021-09-23T03:14:30Z

I will test this Input integration with egui_vulkano_backend as fast as possible.

egui_glium/Cargo.toml

AlexApps99 · 2021-09-23T05:37:48Z

It works! 🎉
Rebased my PR (#685) and most things seem to be working

Once I clean things up a bit, I'll push it to a branch.

Edit: pushed it to AlexApps99/egui@based, there's some bugginess around resizing but that's the only issue I noticed.

TimonPost

Great work, i can't comment on major decisions or fine nuances yet, however didn't find anything that stood out.

Cargo.lock

TimonPost · 2021-09-23T05:49:35Z

ARCHITECTURE.md

@@ -5,7 +5,7 @@ Also see [`CONTRIBUTING.md`](https://github.com/emilk/egui/blob/master/CONTRIBUT


 ## Crate overview
-The crates in this repository are: `egui, emath, epaint, egui, epi, egui_web, egui_glium, egui_demo_lib, egui_demo_app`.
+The crates in this repository are: `egui, emath, epaint, egui, epi, egui_for_winit, egui_web, egui_glium, egui_demo_lib, egui_demo_app`.


Maybe egui_for_winit isn't the right name in the current convention? I read that egui-winit crate name was maybe transferable, So ill just leave this as a reminder.

egui_for_winit/src/lib.rs

egui_glium/src/backend.rs

egui_for_winit/src/lib.rs

KentaTheBugMaker · 2021-09-23T08:48:20Z

I succeeded to integrate this work to my backend .
LGTM

derivator · 2021-09-23T11:57:39Z

Looks very nice. My thoughts:

Maybe document somewhere that take_egui_input takes care of setting RawInput::time as well. It's very convenient, but confusing for someone coming from egui_winit_platform
egui_winit_platform had a convenience function to check if egui wants to handle an event. What are your thoughts on providing something like this?

Gui-Yom

I agree that documenting what this library handles and what it's leaving for the user would be cool.

Also, I spotted a small error with the scale factor.

egui_for_winit/src/lib.rs

luiswirth · 2021-09-24T13:10:50Z

@emilk
I skimmed over the code and egui_for_winit pretty much provides the same functionality as my egui-winit.

I'm ready to give you the crates.io ownership of the egui-winit crate in order for you to claim the name.
Just be sure to increment the version number accordingly, to not screw up semantic versioning (which I already kinda did), since my crate gets basically replaced.

Since egui-winit is part of my eww (egui + winit + wgpu) crate, I would be very excited if we would also officially support a wgpu renderer. Maybe even someday replacing glium.
You can take a look at egui-wgpu if you're interested in such an addition.

eww itself is a wrapper crate, taking care of the interactions between the winit platform and the wgpu renderer. Maybe that's also a consideration.

emilk · 2021-09-25T04:25:37Z

I'm ready to give you the crates.io ownership of the egui-winit crate in order for you to claim the name.

That would be greatly appreciated!

I would be very excited if we would also officially support a wgpu renderer. Maybe even someday replacing glium.

Let's discuss that in #93 instead so this PR doesn't go off topic!

emilk · 2021-09-25T04:28:04Z

Maybe document somewhere that take_egui_input takes care of setting RawInput::time as well. It's very convenient, but confusing for someone coming from egui_winit_platform

Done!

egui_winit_platform had a convenience function to check if egui wants to handle an event. What are your thoughts on providing something like this?

This is a good idea. on_event could even return a true if egui is going to use the given event (though that would complicate that already very long function).

One wrinkle to consider is the TAB key which can be pressed to move focus in egui, e.g. to the first text field. The linked code does not take this into consideration. For many applications all TAB:s should go to egui, but maybe for some games no TAB:s should go to egui.

luiswirth · 2021-09-25T10:42:45Z

@emilk
I've sent you a invitation to become crates.io owner of egui-winit!

This extracts a lot of code from egui_glium into a reusable crate `egui_for_winit`. This can be reused for `egui_glow` (#685) and many other integrations. This replaces the (somewhat outdated) 3rd party [`egui_winit_platform`](https://github.com/hasenbanck/egui_winit_platform) which is used by a few integrations: <https://crates.io/crates/egui_winit_platform/reverse_dependencies>. The name `egui_for_winit` is not great, but `egui_winit` [was already taken](https://crates.io/crates/egui-winit). I would welcome a better name suggestion!

emilk · 2021-09-26T01:38:17Z

The kebab-case of egui-winit is inconsistent with the snake case of all other egui crates (egui_glium etc), but it can't be helped, and it is still a better name than egui_for_winit.

emilk · 2021-09-26T01:43:31Z

TODO:

Add support for "did egui use this event" (hasenbanck/egui_winit_platform@1729825)
Merge this PR (if everyone thinks it looks good)

I'm planning to publish egui-winit together with egui 0.15.0. I have a busy week ahead of me, so it will likely not happen until October.

AlexApps99 reviewed Sep 22, 2021

View reviewed changes

README.md Outdated Show resolved Hide resolved

egui_for_winit/README.md Outdated Show resolved Hide resolved

egui_for_winit/README.md Outdated Show resolved Hide resolved

egui_for_winit/README.md Outdated Show resolved Hide resolved

parasyte reviewed Sep 23, 2021

View reviewed changes

ARCHITECTURE.md Outdated Show resolved Hide resolved

AlexApps99 reviewed Sep 23, 2021

View reviewed changes

egui_glium/Cargo.toml Outdated Show resolved Hide resolved

TimonPost reviewed Sep 23, 2021

View reviewed changes

Gui-Yom suggested changes Sep 23, 2021

View reviewed changes

egui_for_winit/src/lib.rs Outdated Show resolved Hide resolved

emilk force-pushed the egui_for_winit branch from b3ebfed to 0fcb645 Compare September 25, 2021 04:10

coderedart mentioned this pull request Sep 25, 2021

Replace Glium #93

Closed

emilk added 12 commits September 26, 2021 03:17

Improve docs

56fbd99

Fix a bunch of typos (thanks @AlexApps99)

df4727a

Improve documentation

018a8bc

Remember to check for the webbrowser feature flag

d055beb

Add 'links' and 'clipboard' features to egui_glium and egui_for_winit

62539fb

Fix screen_size_in_pixels

d6f29e0

Make clipboard and links default features

a2ff12b

Simulate a clipboard if the feature is turned off

07360b0

Warn when trying to open a link and the links feature is not on

8c625b8

clippy fixes

eb21699

Clean up event loop

3d463a6

emilk force-pushed the egui_for_winit branch from e1f38c8 to 3d463a6 Compare September 26, 2021 01:17

Rename egui_for_winit to egui-winit

d8dc488

on_event: return true if egui desires exclusive use of the event

4b44512

emilk changed the title ~~New crate: egui_for_winit~~ Split out new crate egui-winit from egui_glium Sep 28, 2021

emilk merged commit 1b36863 into master Sep 28, 2021

emilk deleted the egui_for_winit branch September 28, 2021 15:33

mankinskin pushed a commit to mankinskin/egui that referenced this pull request Sep 29, 2021

Split out new crate egui-winit from egui_glium (emilk#735)

b9b415a

follower mentioned this pull request Mar 29, 2022

Evaluate options for core GUI hannobraun/fornjot#116

Closed

emilk mentioned this pull request May 3, 2022

Add egui_wgpu crate #1564

Merged

tosti007 mentioned this pull request Apr 3, 2023

egui-winit: Document State::on_event from unconditionally consuming Tab keypresses #2872

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split out new crate egui-winit from egui_glium #735

Split out new crate egui-winit from egui_glium #735

emilk commented Sep 22, 2021 •

edited

Loading

emilk commented Sep 22, 2021

luiswirth commented Sep 22, 2021

AlexApps99 commented Sep 22, 2021

AlexApps99 left a comment

KentaTheBugMaker commented Sep 23, 2021

AlexApps99 commented Sep 23, 2021 •

edited

Loading

TimonPost left a comment

TimonPost Sep 23, 2021 •

edited

Loading

KentaTheBugMaker commented Sep 23, 2021

derivator commented Sep 23, 2021

Gui-Yom left a comment •

edited

Loading

luiswirth commented Sep 24, 2021

emilk commented Sep 25, 2021

emilk commented Sep 25, 2021 •

edited

Loading

luiswirth commented Sep 25, 2021

emilk commented Sep 26, 2021

emilk commented Sep 26, 2021 •

edited

Loading

Split out new crate egui-winit from egui_glium #735

Split out new crate egui-winit from egui_glium #735

Conversation

emilk commented Sep 22, 2021 • edited Loading

API

emilk commented Sep 22, 2021

luiswirth commented Sep 22, 2021

AlexApps99 commented Sep 22, 2021

AlexApps99 left a comment

Choose a reason for hiding this comment

KentaTheBugMaker commented Sep 23, 2021

AlexApps99 commented Sep 23, 2021 • edited Loading

TimonPost left a comment

Choose a reason for hiding this comment

TimonPost Sep 23, 2021 • edited Loading

Choose a reason for hiding this comment

KentaTheBugMaker commented Sep 23, 2021

derivator commented Sep 23, 2021

Gui-Yom left a comment • edited Loading

Choose a reason for hiding this comment

luiswirth commented Sep 24, 2021

emilk commented Sep 25, 2021

emilk commented Sep 25, 2021 • edited Loading

luiswirth commented Sep 25, 2021

emilk commented Sep 26, 2021

emilk commented Sep 26, 2021 • edited Loading

emilk commented Sep 22, 2021 •

edited

Loading

AlexApps99 commented Sep 23, 2021 •

edited

Loading

TimonPost Sep 23, 2021 •

edited

Loading

Gui-Yom left a comment •

edited

Loading

emilk commented Sep 25, 2021 •

edited

Loading

emilk commented Sep 26, 2021 •

edited

Loading