Add the ability to request a redraw from an external source #12197

R081n · 2024-02-29T08:57:16Z

Hi, this is a minimal implementation of #12159. I wasn't sure if the EventLoopProxy should be wrapped somewhat to make it more explicit.

Objective

Minimal implementation of #12159
When using UpdateMode::Reactive it is currently not possible to request a redraw when a long running task is finished or an external source has new data.

This makes the following possible which will then run an app update once

// EventLoopProxy is Send on most architectures
// The EventLoopProxy can also be saved in a thread local for WASM or a static in other architecturecs
pub fn example(proxy: NonSend<EventLoopProxy<()>>) {
    let clone: EventLoopProxy<()> = proxy.clone();
    thread::spawn(move || {
        // do long work
        clone.send_event(());
    });
}

Solution

By using the EventLoopProxy one can manually send events from external threads to the event loop as UserEvents.
This simply sets redraw_requested when a UserEvent is received.

Changelog

Added the ability to request a redraw from an external source

pub use the event loop proxy

github-actions · 2024-02-29T08:57:27Z

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

mockersf · 2024-02-29T15:49:42Z

crates/bevy_winit/src/lib.rs

@@ -690,6 +692,9 @@ fn handle_winit_event(
                event_loop.set_control_flow(ControlFlow::Wait);
            }
        }
+        Event::UserEvent(_) => {


Could you expose a specific type that should be sent to trigger a redraw rather than match on anything?
Reusing https://docs.rs/bevy/latest/bevy/window/struct.RequestRedraw.html would be nice

I replaced the type with RequestRedraw. Also the reexport is now a type alias which prevents someone from using the wrong generic parameter when requesting the resource

MrGVSV · 2024-02-29T16:01:43Z

crates/bevy_winit/src/lib.rs

@@ -49,6 +49,8 @@ use winit::{
    event_loop::{ControlFlow, EventLoop, EventLoopBuilder, EventLoopWindowTarget},
 };

+pub use winit::event_loop::EventLoopProxy;


Nit: it'd be nice to have some documentation pointing users to this pattern somewhere. Maybe on WinitSettings::desktop_app? Or maybe there's a better place for it?

hi, i added some documentation. I also added it to the bullet points of Reactive and ReactiveLowPower

aevyrie · 2024-03-03T21:43:02Z

This is already possible today by importing EventLoopProxy from winit, if we add this, I think we need to include some docs and helpers. At work, we stuff it in a static so we can access EVENT_LOOP_PROXY anywhere we need it.

Worth noting bevy used to have something similar, so we should probably understand why it was removed before re-adding it: #674

R081n · 2024-03-03T22:08:24Z

This is already possible today by importing EventLoopProxy from winit, if we add this, I think we need to include some docs and helpers. At work, we stuff it in a static so we can access EVENT_LOOP_PROXY anywhere we need it.

@aevyrie Does this still work in 0.13? We used the same in version 0.12 but it was seemingly patched out. This pr is mostly to make the behavior explicit and prevent someone from using the wrong version of the event loop proxy.

aevyrie · 2024-03-03T22:18:33Z

Nope, haven't updated to bevy 0.13 yet. Not sure what you mean by patched out - it's being used in this PR.

This pr is mostly to make the behavior explicit and prevent someone from using the wrong version of the event loop proxy.

Yeah, that's a great point. Not needing to depend on winit manually, which can desync during updates, would be nice.

R081n · 2024-03-03T22:28:49Z

@aevyrie the winit runner received some fixes to reduce sporadic updates. This also lead to the user event having no longer any effect, because the AboutToWait now checks some flags before updating

aevyrie · 2024-03-03T22:30:44Z

Ah good catch. in that case, this PR is also a bugfix for a regression. 😆

@alice-i-cecile IMO this should be be on the 0.13.1 milestone, if the event loop proxy no longer works, that's a pretty serious regression.

R081n · 2024-03-03T22:33:24Z

@aevyrie yeah, i wasn't sure when making it. I did not know if the behavior was intentional ( also a case for better docs 😅)

mockersf

Please make the type of user event explicit instead of "anything". that way it will be a breaking change later if we add support for more events

Hi, this is a minimal implementation of #12159. I wasn't sure if the `EventLoopProxy` should be wrapped somewhat to make it more explicit. Minimal implementation of #12159 When using `UpdateMode::Reactive` it is currently not possible to request a redraw when a long running task is finished or an external source has new data. This makes the following possible which will then run an app update once ``` rust // EventLoopProxy is Send on most architectures // The EventLoopProxy can also be saved in a thread local for WASM or a static in other architecturecs pub fn example(proxy: NonSend<EventLoopProxy<()>>) { let clone: EventLoopProxy<()> = proxy.clone(); thread::spawn(move || { // do long work clone.send_event(()); }); } ``` By using the EventLoopProxy one can manually send events from external threads to the event loop as `UserEvent`s. This simply sets redraw_requested when a `UserEvent` is received. - Added the ability to request a redraw from an external source --------- Co-authored-by: Kellner, Robin <Robin.Kellner@vector.com>

…ne#12197) Hi, this is a minimal implementation of bevyengine#12159. I wasn't sure if the `EventLoopProxy` should be wrapped somewhat to make it more explicit. # Objective Minimal implementation of bevyengine#12159 When using `UpdateMode::Reactive` it is currently not possible to request a redraw when a long running task is finished or an external source has new data. This makes the following possible which will then run an app update once ``` rust // EventLoopProxy is Send on most architectures // The EventLoopProxy can also be saved in a thread local for WASM or a static in other architecturecs pub fn example(proxy: NonSend<EventLoopProxy<()>>) { let clone: EventLoopProxy<()> = proxy.clone(); thread::spawn(move || { // do long work clone.send_event(()); }); } ``` ## Solution By using the EventLoopProxy one can manually send events from external threads to the event loop as `UserEvent`s. This simply sets redraw_requested when a `UserEvent` is received. ## Changelog - Added the ability to request a redraw from an external source --------- Co-authored-by: Kellner, Robin <Robin.Kellner@vector.com>

trigger redraw on user event

ad6332c

pub use the event loop proxy

alice-i-cecile added A-Windowing Platform-agnostic interface layer to run your app in C-Enhancement A new feature labels Feb 29, 2024

alice-i-cecile requested a review from mockersf February 29, 2024 15:27

alice-i-cecile approved these changes Feb 29, 2024

View reviewed changes

alice-i-cecile requested a review from aevyrie February 29, 2024 15:27

mockersf reviewed Feb 29, 2024

View reviewed changes

MrGVSV reviewed Feb 29, 2024

View reviewed changes

doonv approved these changes Feb 29, 2024

View reviewed changes

alice-i-cecile added this to the 0.13.1 milestone Mar 3, 2024

Merge branch 'main' into loop_from_external

dc9e2dc

mockersf requested changes Mar 4, 2024

View reviewed changes

mockersf removed the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Mar 4, 2024

RobinKellnerVector added 3 commits March 4, 2024 09:44

add explicit event type

6b6e508

typo

c7b8413

add documentation

cf7343f

R081n requested a review from mockersf March 4, 2024 09:04

mockersf approved these changes Mar 4, 2024

View reviewed changes

mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Mar 4, 2024

alice-i-cecile added this pull request to the merge queue Mar 4, 2024

Merged via the queue into bevyengine:main with commit d90cb57 Mar 4, 2024
26 checks passed

james7132 mentioned this pull request Mar 10, 2024

Support triggering the winit render loop from an external source #12159

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add the ability to request a redraw from an external source #12197

Add the ability to request a redraw from an external source #12197

R081n commented Feb 29, 2024 •

edited

Loading

github-actions bot commented Feb 29, 2024

mockersf Feb 29, 2024

R081n Mar 4, 2024

MrGVSV Feb 29, 2024

R081n Mar 4, 2024

aevyrie commented Mar 3, 2024 •

edited

Loading

R081n commented Mar 3, 2024

aevyrie commented Mar 3, 2024 •

edited

Loading

R081n commented Mar 3, 2024

aevyrie commented Mar 3, 2024 •

edited

Loading

R081n commented Mar 3, 2024

mockersf left a comment

Add the ability to request a redraw from an external source #12197

Add the ability to request a redraw from an external source #12197

Conversation

R081n commented Feb 29, 2024 • edited Loading

Objective

Solution

Changelog

github-actions bot commented Feb 29, 2024

mockersf Feb 29, 2024

Choose a reason for hiding this comment

R081n Mar 4, 2024

Choose a reason for hiding this comment

MrGVSV Feb 29, 2024

Choose a reason for hiding this comment

R081n Mar 4, 2024

Choose a reason for hiding this comment

aevyrie commented Mar 3, 2024 • edited Loading

R081n commented Mar 3, 2024

aevyrie commented Mar 3, 2024 • edited Loading

R081n commented Mar 3, 2024

aevyrie commented Mar 3, 2024 • edited Loading

R081n commented Mar 3, 2024

mockersf left a comment

Choose a reason for hiding this comment

R081n commented Feb 29, 2024 •

edited

Loading

aevyrie commented Mar 3, 2024 •

edited

Loading

aevyrie commented Mar 3, 2024 •

edited

Loading

aevyrie commented Mar 3, 2024 •

edited

Loading