feat: Winit 0.30.0 #1675

marc2332 · 2024-04-30T20:24:37Z

Tested on all platforms changed
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

… need >1.70

marc2332 · 2024-04-30T22:20:56Z

I bumped the MSRV to 1.70, updated to winit 0.30 and migrate both glutin-winit and the winit-dependant examples to the new trait-based EventLoop API

I would appreciate it if you could test it works in other platforms, I have tried on Windows 11 and it works great!

justincredible · 2024-05-02T06:43:08Z

It's likely undesirable, but the deprecated API can still be supported temporarily by implementing a sealed trait for EventLoop<T> and ActiveEventLoop, then using &impl MySealedTrait instead of &ActiveEventLoop as the parameter to DisplayBuilder::build, create_display, and finalize_window. An enum or Fn + closures also work but are even more awkward.

kchibisov · 2024-05-03T18:02:06Z

glutin-winit/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "glutin-winit"
-version = "0.4.2"
+version = "0.5.0"


Drop the version bump.

kchibisov · 2024-05-03T18:03:00Z

.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
    strategy:
      fail-fast: false
      matrix:
-        rust_version: [1.65.0, stable, nightly]
+        rust_version: [1.70.0, stable, nightly]


Bump rust-version in a separate commit or in a separate PR.

Separate commit? How does that matter? Anyway, I downgraded it again to 1.65 in this PR, but it now fails https://github.com/rust-windowing/glutin/actions/runs/8950601264/job/24586112813?pr=1675#step:8:30, I can open another PR if you want

I'll do that myself, in general, you should just do a separate commit before your work because you require 1.70.

I'll just send a PR myself bumping MSRV.

kchibisov · 2024-05-03T18:04:02Z

glutin_examples/examples/switch_render_thread.rs

+        match event {
+            WindowEvent::CloseRequested => event_loop.exit(),
+            WindowEvent::Resized(size) => {
+                if size.width != 0 && size.height != 0 {


Can move to guard while at it.

kchibisov · 2024-05-03T18:07:53Z

glutin_examples/src/lib.rs

+    ) {
+        match event {
+            WindowEvent::Resized(size) => {
+                if size.width != 0 && size.height != 0 {


move to guard as well.

What guard? There is no multithreading on the standard example

WinodwEvent::Resized(size) if size.width

Ah! Sure, I misunderstood

kchibisov · 2024-05-03T18:09:04Z

glutin_examples/src/lib.rs

+        } else {
+            // Only Windows requires the window to be present before creating the display.


Could you extract all of that into a separate method on Application?

kchibisov · 2024-05-03T18:10:43Z

glutin_examples/src/lib.rs

+    not_current_gl_context: Option<NotCurrentContext>,
+    gl_context: Option<PossiblyCurrentContext>,
+    gl_surface: Option<Surface<WindowSurface>>,
+    window: Option<Window>,
+    gl_config: Option<Config>,
+    renderer: Option<Renderer>,


For the context you should use the same field (treat_as_possibly_current). All gl resources, must be dropped before the window, also add a note that Window is dropped at the end.

Render should be dropped first, because it uses the global GL state. Should document that as well.

All of that applies to multithreaded example as well.

For the context you should use the same field (treat_as_possibly_current).

Can you clarify this?
treat_as_possibly_current consumes the NotCurrentContext so I need to store PossiblyCurrentContext in order to use it 🤔

yes, just always store PossiblyCurrentContext

kchibisov · 2024-05-03T18:18:02Z

It's likely undesirable, but the deprecated API can still be supported temporarily by implementing a sealed trait for EventLoop and ActiveEventLoop, then using &impl MySealedTrait instead of &ActiveEventLoop as the parameter to DisplayBuilder::build, create_display, and finalize_window. An enum or Fn + closures also work but are even more awkward.

Yeah, we should do that as well.

…o feat/winit-0.30.0

marc2332 · 2024-05-13T13:29:43Z

Hey @kchibisov , just updated with the latest changes from master as I just noticed you bumped the MSRV some days ago, do you mind reviewing again? Thanks 😄

MarijnS95

Comparing this to #1678, it looks like that PR is less intrusive with the glutin_examples (i.e. maintaining the original app/state separation), but the glutin-winit changes are almost identical minus your trait.

MarijnS95 · 2024-05-26T08:45:42Z

glutin-winit/src/event_loop.rs

+/// Even though [ActiveEventLoop] is the recommended way for using the event
+/// loop we still want to have support for [EventLoop], for now.


Suggested change

/// Even though [ActiveEventLoop] is the recommended way for using the event

/// loop we still want to have support for [EventLoop], for now.

/// Even though [`ActiveEventLoop`] is the recommended way for using the event

/// loop we still want to have support for [`EventLoop`], for now.

Also: "we still want" is not a valid/useful documentation commit, if you don't first outline why this trait exists and what it does.

MarijnS95 · 2024-05-26T08:50:44Z

glutin-winit/src/lib.rs

-    /// with it when the [`WindowBuilder`] was passed with
-    /// [`Self::with_window_builder`]. It's optional, since on some
+    /// with it when the [`WindowAttributes`] was passed with
+    /// [`Self::with_window_attributes`]. It's optional, since on some


Suggested change

/// [`Self::with_window_attributes`]. It's optional, since on some

/// [`Self::with_window_attributes()`]. It's optional, since on some

MarijnS95 · 2024-05-26T08:53:56Z

glutin-winit/src/lib.rs

-    /// **WGL:** - [`WindowBuilder`] **must** be passed in
-    /// [`Self::with_window_builder`] if modern OpenGL(ES) is desired,
+    /// **WGL:** - [`WindowAttributes`] **must** be passed in
+    /// [`Self::with_window_attributes`] if modern OpenGL(ES) is desired,


Suggested change

/// [`Self::with_window_attributes`] if modern OpenGL(ES) is desired,

/// [`Self::with_window_attributes()`] if modern OpenGL(ES) is desired,

MarijnS95 · 2024-05-26T09:00:03Z

glutin_examples/src/lib.rs

-                #[cfg(android_platform)]
-                println!("Android window available");


Comparing to #1678, you lost this but still kept Android window removed.

kchibisov · 2024-05-26T15:12:59Z

glutin-winit/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased

+# Version 0.5.0
+
+- **Breaking:** Update _winit_ to `0.30`. See [winit's CHANGELOG](https://github.com/rust-windowing/winit/releases/tag/v0.30.0) for more info.


Should mention changes to glutin-winit itself.

kchibisov · 2024-05-26T15:15:37Z

glutin-winit/src/event_loop.rs

+    fn create_window(&self, window_attributes: WindowAttributes) -> Result<Window, OsError>;
+
+    fn glutin_display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>;


Should document what both are for.

glutin_examples/Cargo.toml

kchibisov · 2024-05-26T16:28:43Z

Could apply something like that

diff --git a/glutin-winit/CHANGELOG.md b/glutin-winit/CHANGELOG.md
index a5c458f..9935361 100644
--- a/glutin-winit/CHANGELOG.md
+++ b/glutin-winit/CHANGELOG.md
@@ -1,8 +1,7 @@
 # Unreleased
 
-# Version 0.5.0
-
 - **Breaking:** Update _winit_ to `0.30`. See [winit's CHANGELOG](https://github.com/rust-windowing/winit/releases/tag/v0.30.0) for more info.
+- Add trait `GlutinEventLoop` to handle `{Active,}EventLoop` simultaneously.
 
 # Version 0.4.2
 
diff --git a/glutin_examples/Cargo.toml b/glutin_examples/Cargo.toml
index 981760a..281e1bd 100644
--- a/glutin_examples/Cargo.toml
+++ b/glutin_examples/Cargo.toml
@@ -23,7 +23,7 @@ glutin = { path = "../glutin", default-features = false }
 glutin-winit = { path = "../glutin-winit", default-features = false }
 png = { version = "0.17.6", optional = true }
 raw-window-handle = "0.6"
-winit = { version = "0.30.0", default-features = false, features = ["rwh_05"] }
+winit = { version = "0.30.0", default-features = false, features = ["rwh_06"] }
 
 [target.'cfg(target_os = "android")'.dependencies]
 winit = { version = "0.30.0", default-features = false, features = ["android-native-activity", "rwh_06"] }
diff --git a/glutin_examples/examples/switch_render_thread.rs b/glutin_examples/examples/switch_render_thread.rs
index fea5352..b751c87 100644
--- a/glutin_examples/examples/switch_render_thread.rs
+++ b/glutin_examples/examples/switch_render_thread.rs
@@ -81,19 +81,21 @@ impl Application {
 
 impl ApplicationHandler<PlatformThreadEvent> for Application {
     fn resumed(&mut self, active_event_loop: &ActiveEventLoop) {
-        if self.render_thread_senders.is_none() {
-            let (window, render_context) = create_window_with_render_context(active_event_loop)
-                .expect("Failed to create window.");
-            let render_context = Arc::new(Mutex::new(render_context));
+        if self.render_thread_senders.is_some() {
+            return;
+        }
 
-            let (_render_threads, render_thread_senders) =
-                spawn_render_threads(render_context, &self.event_loop_proxy);
+        let (window, render_context) =
+            create_window_with_render_context(active_event_loop).expect("Failed to create window.");
+        let render_context = Arc::new(Mutex::new(render_context));
 
-            self.window = Some(window);
-            self.render_thread_senders = Some(render_thread_senders);
+        let (_render_threads, render_thread_senders) =
+            spawn_render_threads(render_context, &self.event_loop_proxy);
 
-            self.send_event_to_current_render_thread(RenderThreadEvent::MakeCurrent);
-        }
+        self.window = Some(window);
+        self.render_thread_senders = Some(render_thread_senders);
+
+        self.send_event_to_current_render_thread(RenderThreadEvent::MakeCurrent);
     }
 
     fn user_event(&mut self, _event_loop: &ActiveEventLoop, event: PlatformThreadEvent) {
diff --git a/glutin_examples/src/lib.rs b/glutin_examples/src/lib.rs
index 496efdb..b3e498c 100644
--- a/glutin_examples/src/lib.rs
+++ b/glutin_examples/src/lib.rs
@@ -49,14 +49,9 @@ impl Application {
     fn create_window(&mut self, active_event_loop: &ActiveEventLoop) {
         // Only Windows requires the window to be present before creating the display.
         // Other platforms don't really need one.
-        //
-        // XXX if you don't care about running on Android or so you can safely remove
-        // this condition and always pass the window builder.
-        let window_attributes = cfg!(wgl_backend).then(|| {
-            Window::default_attributes()
-                .with_transparent(true)
-                .with_title("Glutin triangle gradient example (press Escape to exit)")
-        });
+        let window_attributes = Window::default_attributes()
+            .with_transparent(true)
+            .with_title("Glutin triangle gradient example (press Escape to exit)");
 
         // The template will match only the configurations supporting rendering
         // to windows.
@@ -69,7 +64,7 @@ impl Application {
         let template =
             ConfigTemplateBuilder::new().with_alpha_size(8).with_transparency(cfg!(cgl_backend));
 
-        let display_builder = DisplayBuilder::new().with_window_attributes(window_attributes);
+        let display_builder = DisplayBuilder::new().with_window_attributes(Some(window_attributes));
 
         let (window, gl_config) = display_builder
             .build(active_event_loop, template, gl_config_picker)

Since at the current state of things it doesn't work on anything other than windows, I guess.

Co-authored-by: Kirill Chibisov <contact@kchibisov.com>

marc2332 added 5 commits April 30, 2024 22:21

feat: Winit 0.30.0

42f8d2c

fix

2b693ca

clean up

df9312a

clean up

f5b2472

bump version, changelog, bump MSRV from 1.65 to 1.70

253dd16

marc2332 mentioned this pull request Apr 30, 2024

feat: winit v0.30.0 + glutin-winit v0.5.0 + accesskit v0.14.0 + accesskit_winit v0.20.0 marc2332/freya#598

Draft

marc2332 added 10 commits April 30, 2024 23:10

update switch_render_thread

04a6fe2

fix

3613c9e

fix

bf7b8de

fmt

4deeeff

builder -> attributes

145a711

remove android-specific builds for older versions of rust as they all…

730afa0

… need >1.70

fix changelog

9329f60

actually bring back rust specific builds to android in CI

2b3e1a8

fix android example

af6bb0c

fix switch_render_thread example

6233358

marc2332 marked this pull request as ready for review April 30, 2024 22:21

kchibisov requested changes May 3, 2024

View reviewed changes

marc2332 added 9 commits May 4, 2024 13:44

downgrade rust version

97014f9

move size check to render context

ca8b883

move window creation to a separate method

d35cefc

comments

4c99d6c

sealed trait

71b1635

cargo fmt

c2efead

fmt

a29dbbe

remove mention of MSRV bump in changelog

ef6acd0

comment on the trait

1bcb770

marc2332 added 2 commits May 4, 2024 14:42

fix finalize_window

6ea6c20

fmt

fb6121e

marc2332 requested a review from kchibisov May 4, 2024 13:01

clean up

d50f8e3

emilk mentioned this pull request May 6, 2024

Bump winit to 0.30.0 and accesskit to 0.14.0 emilk/egui#4466

Draft

pragmatrix mentioned this pull request May 8, 2024

Port window examples to winit 0.30 rust-skia/rust-skia#974

Draft

5 tasks

Kethku mentioned this pull request May 12, 2024

[request] Acrylic window blur neovide/neovide#2078

Open

Merge branch 'master' of https://github.com/rust-windowing/glutin int…

0ddee11

…o feat/winit-0.30.0

ErichDonGubler mentioned this pull request May 14, 2024

Upgrade winit 0.29.2 → 0.30.0 #1678

Draft

4 tasks

justincredible mentioned this pull request May 25, 2024

Test 'texture_creation/bindless_texture_residency_context_rebuild' Failing glium/glium#2112

Open

chore: Resolve conflicts

006464e

marc2332 mentioned this pull request May 25, 2024

Update raw-window-handle to v0.6 #1670

Merged

4 tasks

MarijnS95 reviewed May 26, 2024

View reviewed changes

marc2332 added 5 commits May 26, 2024 14:14

chore: Clarify the doc comment of GlutinEventLoop

4248d16

docs: Add missing parenthesis in with_window_attributes

998a746

chore: Bring back android log in glutin_examples

7da4e7e

chore: Remove unnecessary absolute imports on examples

67d11f3

chore: cargo fmt

3640b90

kchibisov requested changes May 26, 2024

View reviewed changes

marc2332 and others added 4 commits May 27, 2024 00:16

Update glutin_examples/Cargo.toml

f49f2f9

Co-authored-by: Kirill Chibisov <contact@kchibisov.com>

chore: Update CHANGELOG.md

efdcfb4

docs: Add doc comments to the methods of the GlutinEventLoop trait

ac38d01

fix: Apply suggestions from kchibisov

c39703e

marc2332 requested review from MarijnS95 and kchibisov May 28, 2024 13:33

fix: fmt event_loop.rs

658acb2

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Winit 0.30.0 #1675

feat: Winit 0.30.0 #1675

marc2332 commented Apr 30, 2024 •

edited

marc2332 commented Apr 30, 2024

justincredible commented May 2, 2024

kchibisov May 3, 2024

kchibisov May 3, 2024

marc2332 May 4, 2024

kchibisov May 4, 2024

kchibisov May 3, 2024

kchibisov May 3, 2024

marc2332 May 4, 2024

kchibisov May 4, 2024

marc2332 May 4, 2024

kchibisov May 3, 2024

kchibisov May 3, 2024

marc2332 May 4, 2024 •

edited

kchibisov May 4, 2024

marc2332 May 4, 2024

kchibisov commented May 3, 2024

marc2332 commented May 13, 2024

MarijnS95 left a comment

MarijnS95 May 26, 2024

MarijnS95 May 26, 2024

MarijnS95 May 26, 2024

MarijnS95 May 26, 2024

MarijnS95 May 26, 2024

kchibisov May 26, 2024

kchibisov May 26, 2024

kchibisov commented May 26, 2024

		} else {
		// Only Windows requires the window to be present before creating the display.

		/// Even though [ActiveEventLoop] is the recommended way for using the event
		/// loop we still want to have support for [EventLoop], for now.

	/// [`Self::with_window_attributes`]. It's optional, since on some
	/// [`Self::with_window_attributes()`]. It's optional, since on some

	/// [`Self::with_window_attributes`] if modern OpenGL(ES) is desired,
	/// [`Self::with_window_attributes()`] if modern OpenGL(ES) is desired,

		#[cfg(android_platform)]
		println!("Android window available");

		fn create_window(&self, window_attributes: WindowAttributes) -> Result<Window, OsError>;

		fn glutin_display_handle(&self) -> Result<DisplayHandle<'_>, HandleError>;

feat: Winit 0.30.0 #1675

Are you sure you want to change the base?

feat: Winit 0.30.0 #1675

Conversation

marc2332 commented Apr 30, 2024 • edited

marc2332 commented Apr 30, 2024

justincredible commented May 2, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marc2332 May 4, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kchibisov commented May 3, 2024

marc2332 commented May 13, 2024

MarijnS95 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kchibisov commented May 26, 2024

marc2332 commented Apr 30, 2024 •

edited

marc2332 May 4, 2024 •

edited