Deprecate window creation with stale event loop #3447

kchibisov · 2024-01-31T21:17:49Z

Creating window when event loop is not running generally doesn't work,
since a bunch of events and sync OS requests can't be processed. This
is also an issue on e.g. Android, since window can't be created outside
event loop easily.

Thus deprecate the window creation when event loop is not running,
as well as other resource creation to running event loop.

Given that all the examples use the bad pattern of creating the window
when event loop is not running and also most example existence is
questionable, since they show single thing and the majority of their
code is window/event loop initialization, they wore merged into
a single example 'window.rs' example that showcases very simple
application using winit.

Fixes #3399.

Replaces #3299 and #3400.

Tested on all platforms changed // Kind of.
Added an entry to CHANGELOG.md if knowledge of this change could be valuable to users
Updated documentation to reflect any user-facing changes, including notes of platform-specific behavior
Created or updated an example program if it would help users understand this functionality
Updated feature matrix, if new features were added or implemented

--

@daxpedda could you wire the web example into window.rs example somehow? We maybe also want android there as well, @MarijnS95 , just without drawing, I guess?

kchibisov · 2024-01-31T21:31:07Z

That's based on #3299

In general, I have the following questions:

Should we add ActiveEventLoop getter for pump_events trait? The API is kind of weird and requiring it to be normal doesn't sound right.
Maybe some types like CustomCursor should accept EventLoop instead?
Do we need threaded rendering example...? softbuffer is a bit tricky around threads.
Do we need something else in window example? I've added pretty much everything, though I don't print just all events, since it's a bit noisy.

notgull

1. Should we add `ActiveEventLoop` getter for `pump_events` trait? The API is kind of weird and requiring it to be normal doesn't sound right.

I don't think this works out.

2. Maybe some types like `CustomCursor` should accept `EventLoop` instead?

Maybe we should keep the EventLoopWindowTarget type around for this reason.

3. Do we need threaded rendering example...? softbuffer is a bit tricky around threads.

I'd agree.

4. Do we need something else in window example? I've added pretty much everything, though I don't print just all events, since it's a bit noisy.

Nah.

madsmtm

I think #3400 is the better way forwards for this, as it allows us to still support the "create event loop while it's not running" use-case, but allows us to mark it as deprecated for a release cycle.

madsmtm · 2024-02-01T13:15:01Z

src/window.rs

    /// # use winit::window::Window;
-    /// # let mut event_loop = EventLoop::new().unwrap();
-    /// # let window = Window::new(&event_loop).unwrap();
+    /// # fn scope(window: &Window) {


Maybe?

Suggested change

/// # fn scope(window: &Window) {

/// # let window: &Window = unimplemented!();

Since the examples are no_run anyways.

I'm not sure about it since all the code in examples will be kind of dead with such pattern.

Yeah, on the other hand, if someone forgets no_run, then the example will still mistakenly run, it'll just do nothing.

I'd still probably go with fn for now.

kchibisov · 2024-02-01T13:30:49Z

"create event loop while it's not running"

Do you mean Window here? I'm not so sure about it, since I'd rather force users here to more correct design and allow us to deal with soundness stuff more nicely. The issue is though, that pump_events is a bit out of place and I'm not sure how to enforce lifetimes for it, etc. Like the users are more likely to drop the event loop when using it all together which could lead to issues all over the place. But I guess pump_events stuff should be discussed separately and probably marked as unsafe in the first place?

kchibisov · 2024-02-01T16:13:58Z

I think #3400 is the better way forwards for this

I've applied it for now the way you've suggested. Though, I haven't touched the CustomCursor for example.

kchibisov · 2024-02-01T16:21:04Z

Maybe we should keep the EventLoopWindowTarget type around for this reason.

I think the way forward would be to move CustomCursor into the EventLoop instead of getting the &EventLoopWindowTarget.

madsmtm · 2024-02-02T15:21:08Z

Proposal for custom cursors we discussed at the meeting today:

impl EventLoop {
    fn create_cursor(...);
}

impl ActiveEventLoop {
    fn create_cursor(...);
}

madsmtm

I like the combined example!

Should we add ActiveEventLoop getter for pump_events trait? The API is kind of weird and requiring it to be normal doesn't sound right.

I'm very unsure, but let's punt on it for now, as users still have the option of using EventLoop::create_window.

Do we need threaded rendering example...?

Would be kinda nice at some point, but it can definitely wait.

examples/window.rs

examples/child_window.rs

CHANGELOG.md

examples/pump_events.rs

src/event_loop.rs

src/window.rs

madsmtm · 2024-02-09T15:11:51Z

@daxpedda I've opened #3473 for making the big example work on the web.

kchibisov · 2024-02-09T16:24:01Z

I'd like to merge it after the #3486 , so it'll be easier for me to do patch release, since #3471 will go to 0.29...

jackpot51

Orbital changes are good

madsmtm · 2024-02-13T14:07:14Z

@daxpedda I believe this is waiting mostly on your review

daxpedda

Wow, that's actually a lot of changes in one PR.
LGTM!

src/window.rs

CHANGELOG.md

examples/child_window.rs

CHANGELOG.md

examples/pump_events.rs

src/event_loop.rs

src/window.rs

Creating window when event loop is not running generally doesn't work, since a bunch of events and sync OS requests can't be processed. This is also an issue on e.g. Android, since window can't be created outside event loop easily. Thus deprecate the window creation when event loop is not running, as well as other resource creation to running event loop. Given that all the examples use the bad pattern of creating the window when event loop is not running and also most example existence is questionable, since they show single thing and the majority of their code is window/event loop initialization, they wore merged into a single example 'window.rs' example that showcases very simple application using winit. Fixes #3399.

Replace the `CustomCursorBuilder` with the `CustomCursorSource` and perform the loading of the cursor via the `EventLoop::create_custom_cursor` instead of passing it to the builder itself. This follows the `EventLoop::create_window` API.

Fixes #3477.

kchibisov requested review from jackpot51, msiglreith, daxpedda, madsmtm, notgull and MarijnS95 as code owners January 31, 2024 21:17

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch 3 times, most recently from 7914260 to a612cc3 Compare January 31, 2024 21:28

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch from a612cc3 to caa0d5b Compare January 31, 2024 21:33

notgull approved these changes Feb 1, 2024

View reviewed changes

madsmtm reviewed Feb 1, 2024

View reviewed changes

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch from caa0d5b to 6f463f6 Compare February 1, 2024 16:12

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch 2 times, most recently from 952f9a0 to 32e0f77 Compare February 1, 2024 16:19

kchibisov changed the title ~~Require event loop to run when creating Window~~ Deprecate window creation with stale event loop Feb 1, 2024

This was referenced Feb 2, 2024

Replace EventLoopWindowTarget with ActiveEventLoop #3299

Closed

Remove WindowBuilder in favour of WindowAttributes #3400

Closed

madsmtm mentioned this pull request Feb 2, 2024

Begin transition to a trait-based system #3386

Closed

7 tasks

madsmtm added this to the Version 0.30.0 milestone Feb 2, 2024

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch from 2df6c05 to e593b66 Compare February 3, 2024 03:41

thequver mentioned this pull request Feb 7, 2024

Examples should not create the window outside of the event loop gfx-rs/wgpu#5214

Open

madsmtm approved these changes Feb 9, 2024

View reviewed changes

madsmtm mentioned this pull request Feb 9, 2024

Merge web example into window example #3473

Closed

madsmtm added S - api Design and usability S - docs Awareness, docs, examples, etc. labels Feb 9, 2024

kchibisov mentioned this pull request Feb 9, 2024

Write migrations for each release #3477

Closed

jackpot51 approved these changes Feb 10, 2024

View reviewed changes

daxpedda approved these changes Feb 14, 2024

View reviewed changes

src/window.rs Outdated Show resolved Hide resolved

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch from e593b66 to ec87160 Compare February 18, 2024 01:10

kchibisov requested a review from madsmtm February 18, 2024 01:10

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch 3 times, most recently from 661d15d to ec4fafe Compare February 19, 2024 05:07

madsmtm mentioned this pull request Feb 20, 2024

Move changelog to crate documentation #3496

Merged

madsmtm approved these changes Feb 20, 2024

View reviewed changes

msiglreith approved these changes Feb 20, 2024

View reviewed changes

madsmtm mentioned this pull request Feb 20, 2024

feat: Event::Reopen support for macOS #3499

Closed

5 tasks

kchibisov added 2 commits February 21, 2024 14:26

kchibisov force-pushed the kchibisov/restrict-window-to-loop branch from 649c71e to ba0e8c5 Compare February 21, 2024 10:27

Pin bumpalo to 3.14.0 on CI

9b58647

kchibisov merged commit a8c7109 into master Feb 21, 2024
51 checks passed

kchibisov deleted the kchibisov/restrict-window-to-loop branch February 21, 2024 10:44

madsmtm mentioned this pull request Feb 23, 2024

All of the examples are missing #3512

Closed

dtzxporter mentioned this pull request Feb 24, 2024

Windows need to be created in the winit event loop after receiving Resumed. iced-rs/iced#2241

Closed

2 tasks

madsmtm mentioned this pull request Mar 1, 2024

Refactor main example #3542

Open

1 task

madsmtm added a commit that referenced this pull request Mar 28, 2024

Write migration instructions for #3447 and #3517

ce8b140

Fixes #3477.

This was referenced Aug 15, 2024

First window created is not in a tab on macOS... #2238

Closed

macOS regresssion: new window starts on top of fullscreen window #2051

Closed

Crash in iOS when swiping up for the control center #1705

Closed

macOS/iOS: Remove window activation hacks #3872

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate window creation with stale event loop #3447

Deprecate window creation with stale event loop #3447

kchibisov commented Jan 31, 2024 •

edited

Loading

kchibisov commented Jan 31, 2024 •

edited

Loading

notgull left a comment

madsmtm left a comment

madsmtm Feb 1, 2024

kchibisov Feb 1, 2024

madsmtm Feb 1, 2024

kchibisov Feb 9, 2024

kchibisov commented Feb 1, 2024

kchibisov commented Feb 1, 2024

kchibisov commented Feb 1, 2024

madsmtm commented Feb 2, 2024 •

edited

Loading

madsmtm left a comment

madsmtm commented Feb 9, 2024

kchibisov commented Feb 9, 2024 •

edited by daxpedda

Loading

jackpot51 left a comment

madsmtm commented Feb 13, 2024

daxpedda left a comment

	/// # fn scope(window: &Window) {
	/// # let window: &Window = unimplemented!();

Deprecate window creation with stale event loop #3447

Deprecate window creation with stale event loop #3447

Conversation

kchibisov commented Jan 31, 2024 • edited Loading

kchibisov commented Jan 31, 2024 • edited Loading

notgull left a comment

Choose a reason for hiding this comment

madsmtm left a comment

Choose a reason for hiding this comment

madsmtm Feb 1, 2024

Choose a reason for hiding this comment

kchibisov Feb 1, 2024

Choose a reason for hiding this comment

madsmtm Feb 1, 2024

Choose a reason for hiding this comment

kchibisov Feb 9, 2024

Choose a reason for hiding this comment

kchibisov commented Feb 1, 2024

kchibisov commented Feb 1, 2024

kchibisov commented Feb 1, 2024

madsmtm commented Feb 2, 2024 • edited Loading

madsmtm left a comment

Choose a reason for hiding this comment

madsmtm commented Feb 9, 2024

kchibisov commented Feb 9, 2024 • edited by daxpedda Loading

jackpot51 left a comment

Choose a reason for hiding this comment

madsmtm commented Feb 13, 2024

daxpedda left a comment

Choose a reason for hiding this comment

kchibisov commented Jan 31, 2024 •

edited

Loading

kchibisov commented Jan 31, 2024 •

edited

Loading

madsmtm commented Feb 2, 2024 •

edited

Loading

kchibisov commented Feb 9, 2024 •

edited by daxpedda

Loading