Library upgrades and updates #940

tychedelia · 2023-10-10T21:45:15Z

Mostly working, but need to double check a few things around egui. And make sure all the shaders are still working with wgsl changes.

Switch from async-std to tokio.
Switch from egui_wgpu_backend to the in-tree egui-wgpu.
Upgrade to egui version 0.23.
Upgrade to wgpu version 0.17.
Upgrade to winit version 0.28.

TODO:

Ensure all targets (i.e. WASM) still working.
Figure out whether we can use eframe as a replacement for epi in the new egui version. (answer: no)
Resolve issue from Library upgrades and updates #940 (comment) in the draw_capture_hi_res example.
Figure out resize issue on Ubuntu.
Establish egui pattern to replace epi.
Egui demo colors.

infinity-creative · 2023-10-11T06:26:28Z

I can confirm that egui seems to be working correctly in my project. I will let you know if anything comes up.

infinity-creative · 2023-10-11T07:38:34Z

Wasm builds now break.

I think this is due to converting to tokio.

tokio+mio - seems to break on WASM

 Compiling mio v0.8.8
error[E0432]: unresolved import `crate::sys::IoSourceState`

infinity-creative · 2023-10-11T10:22:24Z

@tychedelia I attempted to test WASM compiling by pulling out tokio. But got suck (new to rust) - I have left a PR on your repo it might help it might not :)

tychedelia · 2023-10-11T17:32:03Z

@tychedelia I attempted to test WASM compiling by pulling out tokio. But got suck (new to rust) - I have left a PR on your repo it might help it might not :)

Thanks! I totally blanked on testing WASM. I'll give your change a shot today or otherwise make sure things are working with the WASM builds.

tychedelia · 2023-10-11T21:02:52Z

@infinitylunacreative just pushed some fixes that should allow tokio to run on wasm targets. will you give it a shot and let me know if that works (on the head of my fork)?

tychedelia · 2023-10-11T21:32:12Z

Looks like @mitchmindtree ran into some of the same questions re: eframe in this previous upgrade attempt here #861. It does appear that the upstream might be willing to accept changes to eframe to make it work better with our use case. It would be wonderful if there was a more fully featured example of a nannou app that uses the previous epi functionality, but I couldn't find one.

infinity-creative · 2023-10-12T03:06:55Z

@infinitylunacreative just pushed some fixes that should allow tokio to run on wasm targets. will you give it a shot and let me know if that works (on the head of my fork)?

Thanks, I will take a look today.

infinity-creative · 2023-10-12T03:23:11Z

@tychedelia I can confirm the WASAM build is working for me 🥳 - Thank you!

infinity-creative · 2023-10-12T09:43:20Z

@tychedelia I decided to do some more testing. I tried it on linux. WASAM works great.

However the "normal" builds throw this error.

error[E0432]: unresolved import `winit::platform::unix`
   --> /home/infinity/work/nannou/nannou/src/window.rs:783:34
    |
783 |             use winit::platform::unix::WindowBuilderExtUnix;
    |                                  ^^^^ could not find `unix` in `platform`

error[E0599]: no method named `with_class` found for struct `WindowBuilder` in the current scope
   --> /home/infinity/work/nannou/nannou/src/window.rs:784:29
    |
784 |             window = window.with_class("nannou".to_string(), "nannou".to_string());
    |                             ^^^^^^^^^^ method not found in `WindowBuilder`

tychedelia · 2023-10-12T20:03:29Z

@tychedelia I decided to do some more testing. I tried it on linux. WASAM works great.

However the "normal" builds throw this error.

error[E0432]: unresolved import `winit::platform::unix`
   --> /home/infinity/work/nannou/nannou/src/window.rs:783:34
    |
783 |             use winit::platform::unix::WindowBuilderExtUnix;
    |                                  ^^^^ could not find `unix` in `platform`

error[E0599]: no method named `with_class` found for struct `WindowBuilder` in the current scope
   --> /home/infinity/work/nannou/nannou/src/window.rs:784:29
    |
784 |             window = window.with_class("nannou".to_string(), "nannou".to_string());
    |                             ^^^^^^^^^^ method not found in `WindowBuilder`

Looks like there was a breaking change in winit: https://github.com/rust-windowing/winit/blob/master/CHANGELOG.md?plain=1#L255.

Not sure the best approach here. I think I'm going to enable xorg by default and make wayland an additional feature flag.

infinity-creative · 2023-10-19T09:05:47Z

@RobWalt @tychedelia - Is there anything you need/want me to test?

RobWalt

@tychedelia What's the motivation behind the switch to tokio? I get that async-std isn't the latest async runtime. In the context of graphics programming with wgpu I just saw a lot of use of pollster instead and maybe that's useful here aswell since we're always just blocking anyways?

Imo it would be better if we split this PR into smaller ones which have a smaller scope. So the async refactor could be its own PR and so on.

anselanza · 2023-12-13T15:10:29Z

I can't offer much help here, but just want to commend the effort to bring Nannou up to date regarding WGPU and Egui. I really like this framework - and have used it in at least one project in production - but I was getting concerned about the apparent lack of updates recently.

tychedelia · 2024-01-13T06:38:08Z

Since I opened this, winit has released an 0.29 version which includes their event loop 3.0 rework that has a substantial number of changes. I've attempted an upgrade, and while there's a lot of little fiddly changes that aren't too bad, there are some substantial changes that are somewhat difficult to integrate.

Key has been split into an an enum representing differences between character keys and "named" keys.
LOTS of changes to events emitted by winit. The biggest is probably moving RedrawRequested to WindowEvent. These are probably not too bad to refactor but there's lots of changes here and so it's a bit hard to analyze what events might be relevant to users.

It would be really nice to be able to land a 29.x upgrade in order to get nannou up to a stable state with regards to one of its most important dependencies, but this potentially will incur a lot of user visible breakage for what's ultimately pretty minimal gain for the user.

tychedelia · 2024-01-15T00:44:30Z

36a724e fixes the issue with the egui demo app, but isn't the right pattern for our users. likely more to do here, it's rendering correctly now though.

tychedelia · 2024-01-17T04:01:10Z

nannou_egui_demo_app/src/main.rs

-    let proxy = app.create_proxy();
-    egui.do_frame_with_epi_frame(proxy, |ctx, epi_frame| {
-        egui_demo_app.setup(&ctx, epi_frame, None);
+    let mut egui_demo_app = egui_demo_lib::DemoWindows::default();


Not sure the best way to clean this up. Maybe make the Egui constructors accept an App instance so we can wire that up internally?

tychedelia · 2024-01-17T04:01:44Z

nannou_egui_demo_app/src/main.rs

-    egui.do_frame_with_epi_frame(proxy, |ctx, frame| {
-        egui_demo_app.update(&ctx, frame);
-    });
+    let ctx = egui.begin_frame();


These should probably just be moved into a do_with_frame method on egui to keep it simple.

mitchmindtree

Wicked work @tychedelia, I really appreciate you diving into this!

I've opened up a PR with some small tweaks and fixes if you're interested here - once those are merged I'd be more than happy to see this land :)

As a small side-note, it seems like this PR runs into the same issues that I ran into in #861 w.r.t. colours not quite matching up. From memory, this has something to do with egui changing something related to the way they do gamma correction in their fragment shader and some assumptions they make around web targets vs desktop targets. I think nannou uniquely runs into this as we don't target the window surface texture directly like most egui apps do - instead we draw to an intermediary frame with a linear colour format.

All that said, I think we might be best to:

Land this as is (with aforementioned tweaks PR)
Open an issue for tracking the egui colour problem.
Aim to solve the problem through our bevy refactor when switching from nannou_egui to the bevy_egui crate.

This still might require some thought around texture colour formats etc, but I think we're better off investing that effort as a part of the bevy-refactor, rather than delaying it longer? Open to other suggestions!

mitchmindtree · 2023-10-12T23:19:09Z

nannou_egui/src/lib.rs

+// impl epi::RepaintSignal for RepaintSignal {
+//     fn request_repaint(&self) {
+//         if let Ok(guard) = self.0.lock() {
+//             guard.wakeup().ok();
+//         }
+//     }
+// }


Happy for this to be removed if it's no longer required?

good catch, thanks!

Oh woops was going to address this in the other PR but I forgot 😅

tychedelia · 2024-01-17T04:31:37Z

@mitchmindtree yeah, seeing the colors are super noticeable here in the color picker example.

i'm good with this plan! we can fast follow anything that might come up from further user testing.

mitchmindtree · 2024-01-17T05:24:53Z

Okydokey let's land this!

I'll follow-up with a PR bumping versions so we can publish to crates.io 👍

tychedelia added 11 commits October 7, 2023 13:30

Convert to Tokio.

9b83605

Bump wgpu.

3c7c832

https://github.com/gfx-rs/wgpu/pull/2698.

67c531f

https://github.com/gfx-rs/wgpu/pull/2171

2c456d0

https://github.com/gfx-rs/wgpu/pull/3610

2595135

More misc fixes.

fc76e0f

More misc fixes.

80185c7

More misc fixes.

3713d27

More misc fixes. Update textures.

b76d778

More misc fixes. Update textures.

fd2b1d8

More misc fixes. Update textures.

7801016

tychedelia mentioned this pull request Oct 10, 2023

Maintenance status + becoming a maintainer? #939

Open

tychedelia added 3 commits October 10, 2023 15:33

Fix font example.

ed80029

wgsl fixes.

77d9a01

wgsl fixes.

06b7b87

tychedelia added 2 commits October 11, 2023 14:00

Fix wasm build.

3dbf3cb

Fix wasm build.

1648fd4

tychedelia mentioned this pull request Oct 11, 2023

Update to wgpu 0.12, egui 0.18 #861

Closed

6 tasks

tychedelia force-pushed the master branch from 8726b22 to cc1af6a Compare October 12, 2023 20:07

Fix winit breaking changes; default to x11, add wayland feature.

a92e343

RobWalt reviewed Oct 19, 2023

View reviewed changes

mitchmindtree mentioned this pull request Dec 31, 2023

State of nannou, thoughts on direction (bevy plugins?), maintainers welcome #946

Closed

Remove reframe and get demo app to render correctly.

36a724e

tychedelia and others added 2 commits January 14, 2024 16:53

Fix shaders from wgsl update.

65bfc5f

fix: adjust texture sample type in certain scenarios

298efa8

tychedelia marked this pull request as ready for review January 17, 2024 02:38

tychedelia added 3 commits January 16, 2024 18:54

Add missing futures dep to examples project.

5a4fc6f

Rustfmt.

70eed1d

Add tokio to examples.

c1d2e8c

tychedelia requested review from JoshuaBatty and mitchmindtree January 17, 2024 03:02

tychedelia commented Jan 17, 2024

View reviewed changes

mitchmindtree reviewed Jan 17, 2024

View reviewed changes

mitchmindtree and others added 6 commits January 16, 2024 20:20

Address warnings in nannou_laser ffi module

b7494fb

Address remaining warnings throughout nannou crates

c7f0aff

fix minor syntax errors in wgpu example fragment shaders

69b3f19

fix wgpu_teapot_camera example panic when cursor grabbing unsupported

1fba132

Remove epi vestige.

b16af95

Rustfmt.

2bb75d2

mitchmindtree merged commit 4500106 into nannou-org:master Jan 17, 2024
9 checks passed

This was referenced Jan 17, 2024

nannou_osc: update rosc from 0.1 to 0.10 #948

Merged

Update to winit 0.27. Handle new window events (IME and Occluded) #904

Closed

nannou_egui colours too light / incorrect gamma handling #958

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Library upgrades and updates #940

Library upgrades and updates #940

tychedelia commented Oct 10, 2023 •

edited

Loading

infinity-creative commented Oct 11, 2023 •

edited

Loading

infinity-creative commented Oct 11, 2023 •

edited

Loading

infinity-creative commented Oct 11, 2023

tychedelia commented Oct 11, 2023

tychedelia commented Oct 11, 2023

tychedelia commented Oct 11, 2023

infinity-creative commented Oct 12, 2023

infinity-creative commented Oct 12, 2023

infinity-creative commented Oct 12, 2023

tychedelia commented Oct 12, 2023

infinity-creative commented Oct 19, 2023

RobWalt left a comment •

edited

Loading

anselanza commented Dec 13, 2023

tychedelia commented Jan 13, 2024 •

edited

Loading

tychedelia commented Jan 15, 2024

tychedelia Jan 17, 2024

tychedelia Jan 17, 2024

mitchmindtree left a comment

mitchmindtree Oct 12, 2023

tychedelia Jan 17, 2024

mitchmindtree Jan 17, 2024

tychedelia commented Jan 17, 2024

mitchmindtree commented Jan 17, 2024

Library upgrades and updates #940

Library upgrades and updates #940

Conversation

tychedelia commented Oct 10, 2023 • edited Loading

infinity-creative commented Oct 11, 2023 • edited Loading

infinity-creative commented Oct 11, 2023 • edited Loading

infinity-creative commented Oct 11, 2023

tychedelia commented Oct 11, 2023

tychedelia commented Oct 11, 2023

tychedelia commented Oct 11, 2023

infinity-creative commented Oct 12, 2023

infinity-creative commented Oct 12, 2023

infinity-creative commented Oct 12, 2023

tychedelia commented Oct 12, 2023

infinity-creative commented Oct 19, 2023

RobWalt left a comment • edited Loading

Choose a reason for hiding this comment

anselanza commented Dec 13, 2023

tychedelia commented Jan 13, 2024 • edited Loading

tychedelia commented Jan 15, 2024

tychedelia Jan 17, 2024

Choose a reason for hiding this comment

tychedelia Jan 17, 2024

Choose a reason for hiding this comment

mitchmindtree left a comment

Choose a reason for hiding this comment

mitchmindtree Oct 12, 2023

Choose a reason for hiding this comment

tychedelia Jan 17, 2024

Choose a reason for hiding this comment

mitchmindtree Jan 17, 2024

Choose a reason for hiding this comment

tychedelia commented Jan 17, 2024

mitchmindtree commented Jan 17, 2024

tychedelia commented Oct 10, 2023 •

edited

Loading

infinity-creative commented Oct 11, 2023 •

edited

Loading

infinity-creative commented Oct 11, 2023 •

edited

Loading

RobWalt left a comment •

edited

Loading

tychedelia commented Jan 13, 2024 •

edited

Loading