diff --git a/Cargo.toml b/Cargo.toml index 7a70c5721e..8d1645b2da 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "winit" -version = "0.29.15" +version = "0.30.0" authors = [ "The winit contributors", "Pierre Krieger ", diff --git a/README.md b/README.md index 01376de776..f636bfef38 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ```toml [dependencies] -winit = "0.29.15" +winit = "0.30.0" ``` ## [Documentation](https://docs.rs/winit) diff --git a/src/changelog/mod.rs b/src/changelog/mod.rs index ee86b84a11..a05ea9ccd2 100644 --- a/src/changelog/mod.rs +++ b/src/changelog/mod.rs @@ -5,7 +5,10 @@ // Put the current entry at the top of this page, for discoverability. // See `.cargo/config.toml` for details about `unreleased_changelogs`. #![cfg_attr(unreleased_changelogs, doc = include_str!("unreleased.md"))] -#![cfg_attr(not(unreleased_changelogs), doc = include_str!("v0.29.md"))] +#![cfg_attr(not(unreleased_changelogs), doc = include_str!("v0.30.md"))] + +#[doc = include_str!("v0.30.md")] +pub mod v0_30 {} #[doc = include_str!("v0.29.md")] pub mod v0_29 {} diff --git a/src/changelog/unreleased.md b/src/changelog/unreleased.md index c3b5b281b9..f3a0f6d2c3 100644 --- a/src/changelog/unreleased.md +++ b/src/changelog/unreleased.md @@ -39,226 +39,3 @@ The migration guide could reference other migration examples in the current changelog entry. ## Unreleased - -### Added - -- Add `OwnedDisplayHandle` type for allowing safe display handle usage outside of - trivial cases. -- Add `ApplicationHandler` trait which mimics `Event`. -- Add `WindowBuilder::with_cursor` and `Window::set_cursor` which takes a - `CursorIcon` or `CustomCursor`. -- Add `Sync` implementation for `EventLoopProxy`. -- Add `Window::default_attributes` to get default `WindowAttributes`. -- Add `EventLoop::builder` to get `EventLoopBuilder` without export. -- Add `CustomCursor::from_rgba` to allow creating cursor images from RGBA data. -- Add `CustomCursorExtWebSys::from_url` to allow loading cursor images from URLs. -- Add `CustomCursorExtWebSys::from_animation` to allow creating animated - cursors from other `CustomCursor`s. -- Add `{Active,}EventLoop::create_custom_cursor` to load custom cursor image sources. -- Add `ActiveEventLoop::create_window` and `EventLoop::create_window`. -- Add `CustomCursor` which could be set via `Window::set_cursor`, implemented on - Windows, macOS, X11, Wayland, and Web. -- On Web, add to toggle calling `Event.preventDefault()` on `Window`. -- On iOS, add `PinchGesture`, `DoubleTapGesture`, `PanGesture` and `RotationGesture`. -- on iOS, use `UIGestureRecognizerDelegate` for fine grained control of gesture recognizers. -- On macOS, add services menu. -- On Windows, add `with_title_text_color`, and `with_corner_preference` on - `WindowAttributesExtWindows`. -- On Windows, implement resize increments. -- On Windows, add `AnyThread` API to access window handle off the main thread. - -### Changed - -- Bump MSRV from `1.65` to `1.70`. -- On Wayland, bump `sctk-adwaita` to `0.9.0`, which changed system library - crates. This change is a **cascading breaking change**, you must do breaking - change as well, even if you don't expose winit. -- Rename `TouchpadMagnify` to `PinchGesture`. -- Rename `SmartMagnify` to `DoubleTapGesture`. -- Rename `TouchpadRotate` to `RotationGesture`. -- Rename `EventLoopWindowTarget` to `ActiveEventLoop`. -- Rename `platform::x11::XWindowType` to `platform::x11::WindowType`. -- Rename `VideoMode` to `VideoModeHandle` to represent that it doesn't hold - static data. -- Make `Debug` formatting of `WindowId` more concise. -- Move `dpi` types to its own crate, and re-export it from the root crate. -- Replace `log` with `tracing`, use `log` feature on `tracing` to restore old - behavior. -- `EventLoop::with_user_event` now returns `EventLoopBuilder`. -- On Web, return `HandleError::Unavailable` when a window handle is not available. -- On Web, return `RawWindowHandle::WebCanvas` instead of `RawWindowHandle::Web`. -- On Web, remove queuing fullscreen request in absence of transient activation. -- On iOS, return `HandleError::Unavailable` when a window handle is not available. -- On macOS, return `HandleError::Unavailable` when a window handle is not available. -- On Windows, remove `WS_CAPTION`, `WS_BORDER`, and `WS_EX_WINDOWEDGE` styles - for child windows without decorations. -- On Android, bump `ndk` to `0.9.0` and `android-activity` to `0.6.0`, - and remove unused direct dependency on `ndk-sys`. - -### Deprecated - -- Deprecate `EventLoop::run`, use `EventLoop::run_app`. -- Deprecate `EventLoopExtRunOnDemand::run_on_demand`, use `EventLoop::run_app_on_demand`. -- Deprecate `EventLoopExtPumpEvents::pump_events`, use `EventLoopExtPumpEvents::pump_app_events`. - - The new `app` APIs accept a newly added `ApplicationHandler` instead of - `Fn`. The semantics are mostly the same, given that the capture list of the - closure is your new `State`. Consider the following code: - - ```rust,no_run - use winit::event::Event; - use winit::event_loop::EventLoop; - use winit::window::Window; - - struct MyUserEvent; - - let event_loop = EventLoop::::with_user_event().build().unwrap(); - let window = event_loop.create_window(Window::default_attributes()).unwrap(); - let mut counter = 0; - - let _ = event_loop.run(move |event, event_loop| { - match event { - Event::AboutToWait => { - window.request_redraw(); - counter += 1; - } - Event::WindowEvent { window_id, event } => { - // Handle window event. - } - Event::UserEvent(event) => { - // Handle user event. - } - Event::DeviceEvent { device_id, event } => { - // Handle device event. - } - _ => (), - } - }); - ``` - - To migrate this code, you should move all the captured values into some - newtype `State` and implement `ApplicationHandler` for this type. Finally, - we move particular `match event` arms into methods on `ApplicationHandler`, - for example: - - ```rust,no_run - use winit::application::ApplicationHandler; - use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId}; - use winit::event_loop::{EventLoop, ActiveEventLoop}; - use winit::window::{Window, WindowId}; - - struct MyUserEvent; - - struct State { - window: Window, - counter: i32, - } - - impl ApplicationHandler for State { - fn user_event(&mut self, event_loop: &ActiveEventLoop, user_event: MyUserEvent) { - // Handle user event. - } - - fn resumed(&mut self, event_loop: &ActiveEventLoop) { - // Your application got resumed. - } - - fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) { - // Handle window event. - } - - fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) { - // Handle device event. - } - - fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) { - self.window.request_redraw(); - self.counter += 1; - } - } - - let event_loop = EventLoop::::with_user_event().build().unwrap(); - #[allow(deprecated)] - let window = event_loop.create_window(Window::default_attributes()).unwrap(); - let mut state = State { window, counter: 0 }; - - let _ = event_loop.run_app(&mut state); - ``` - - Please submit your feedback after migrating in [this issue](https://github.com/rust-windowing/winit/issues/3626). - -- Deprecate `Window::set_cursor_icon`, use `Window::set_cursor`. - -### Removed - -- Remove `Window::new`, use `ActiveEventLoop::create_window` instead. - - You now have to create your windows inside the actively running event loop - (usually the `new_events(cause: StartCause::Init)` or `resumed()` events), - and can no longer do it before the application has properly launched. - This change is done to fix many long-standing issues on iOS and macOS, and - will improve things on Wayland once fully implemented. - - To ease migration, we provide the deprecated `EventLoop::create_window` that - will allow you to bypass this restriction in this release. - - Using the migration example from above, you can change your code as follows: - - ```rust,no_run - use winit::application::ApplicationHandler; - use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId}; - use winit::event_loop::{EventLoop, ActiveEventLoop}; - use winit::window::{Window, WindowId}; - - #[derive(Default)] - struct State { - // Use an `Option` to allow the window to not be available until the - // application is properly running. - window: Option, - counter: i32, - } - - impl ApplicationHandler for State { - // This is a common indicator that you can create a window. - fn resumed(&mut self, event_loop: &ActiveEventLoop) { - self.window = Some(event_loop.create_window(Window::default_attributes()).unwrap()); - } - fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) { - // `unwrap` is fine, the window will always be available when - // receiving a window event. - let window = self.window.as_ref().unwrap(); - // Handle window event. - } - fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) { - // Handle window event. - } - fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) { - if let Some(window) = self.window.as_ref() { - window.request_redraw(); - self.counter += 1; - } - } - } - - let event_loop = EventLoop::new().unwrap(); - let mut state = State::default(); - let _ = event_loop.run_app(&mut state); - ``` - -- Remove `Deref` implementation for `EventLoop` that gave `EventLoopWindowTarget`. -- Remove `WindowBuilder` in favor of `WindowAttributes`. -- Remove Generic parameter `T` from `ActiveEventLoop`. -- Remove `EventLoopBuilder::with_user_event`, use `EventLoop::with_user_event`. -- Remove Redundant `EventLoopError::AlreadyRunning`. -- Remove `WindowAttributes::fullscreen` and expose as field directly. -- On X11, remove `platform::x11::XNotSupported` export. - -### Fixed - -- On Web, fix setting cursor icon overriding cursor visibility. -- On Windows, fix cursor not confined to center of window when grabbed and hidden. -- On macOS, fix sequence of mouse events being out of order when dragging on the trackpad. -- On Wayland, fix decoration glitch on close with some compositors. -- On Android, fix a regression introduced in #2748 to allow volume key events to be received again. -- On Windows, don't return a valid window handle outside of the GUI thread. -- On macOS, don't set the background color when initializing a window with transparency. diff --git a/src/changelog/v0.30.md b/src/changelog/v0.30.md new file mode 100644 index 0000000000..e82a162a55 --- /dev/null +++ b/src/changelog/v0.30.md @@ -0,0 +1,224 @@ +## 0.30.0 + +### Added + +- Add `OwnedDisplayHandle` type for allowing safe display handle usage outside of + trivial cases. +- Add `ApplicationHandler` trait which mimics `Event`. +- Add `WindowBuilder::with_cursor` and `Window::set_cursor` which takes a + `CursorIcon` or `CustomCursor`. +- Add `Sync` implementation for `EventLoopProxy`. +- Add `Window::default_attributes` to get default `WindowAttributes`. +- Add `EventLoop::builder` to get `EventLoopBuilder` without export. +- Add `CustomCursor::from_rgba` to allow creating cursor images from RGBA data. +- Add `CustomCursorExtWebSys::from_url` to allow loading cursor images from URLs. +- Add `CustomCursorExtWebSys::from_animation` to allow creating animated + cursors from other `CustomCursor`s. +- Add `{Active,}EventLoop::create_custom_cursor` to load custom cursor image sources. +- Add `ActiveEventLoop::create_window` and `EventLoop::create_window`. +- Add `CustomCursor` which could be set via `Window::set_cursor`, implemented on + Windows, macOS, X11, Wayland, and Web. +- On Web, add to toggle calling `Event.preventDefault()` on `Window`. +- On iOS, add `PinchGesture`, `DoubleTapGesture`, `PanGesture` and `RotationGesture`. +- on iOS, use `UIGestureRecognizerDelegate` for fine grained control of gesture recognizers. +- On macOS, add services menu. +- On Windows, add `with_title_text_color`, and `with_corner_preference` on + `WindowAttributesExtWindows`. +- On Windows, implement resize increments. +- On Windows, add `AnyThread` API to access window handle off the main thread. + +### Changed + +- Bump MSRV from `1.65` to `1.70`. +- On Wayland, bump `sctk-adwaita` to `0.9.0`, which changed system library + crates. This change is a **cascading breaking change**, you must do breaking + change as well, even if you don't expose winit. +- Rename `TouchpadMagnify` to `PinchGesture`. +- Rename `SmartMagnify` to `DoubleTapGesture`. +- Rename `TouchpadRotate` to `RotationGesture`. +- Rename `EventLoopWindowTarget` to `ActiveEventLoop`. +- Rename `platform::x11::XWindowType` to `platform::x11::WindowType`. +- Rename `VideoMode` to `VideoModeHandle` to represent that it doesn't hold + static data. +- Make `Debug` formatting of `WindowId` more concise. +- Move `dpi` types to its own crate, and re-export it from the root crate. +- Replace `log` with `tracing`, use `log` feature on `tracing` to restore old + behavior. +- `EventLoop::with_user_event` now returns `EventLoopBuilder`. +- On Web, return `HandleError::Unavailable` when a window handle is not available. +- On Web, return `RawWindowHandle::WebCanvas` instead of `RawWindowHandle::Web`. +- On Web, remove queuing fullscreen request in absence of transient activation. +- On iOS, return `HandleError::Unavailable` when a window handle is not available. +- On macOS, return `HandleError::Unavailable` when a window handle is not available. +- On Windows, remove `WS_CAPTION`, `WS_BORDER`, and `WS_EX_WINDOWEDGE` styles + for child windows without decorations. +- On Android, bump `ndk` to `0.9.0` and `android-activity` to `0.6.0`, + and remove unused direct dependency on `ndk-sys`. + +### Deprecated + +- Deprecate `EventLoop::run`, use `EventLoop::run_app`. +- Deprecate `EventLoopExtRunOnDemand::run_on_demand`, use `EventLoop::run_app_on_demand`. +- Deprecate `EventLoopExtPumpEvents::pump_events`, use `EventLoopExtPumpEvents::pump_app_events`. + + The new `app` APIs accept a newly added `ApplicationHandler` instead of + `Fn`. The semantics are mostly the same, given that the capture list of the + closure is your new `State`. Consider the following code: + + ```rust,no_run + use winit::event::Event; + use winit::event_loop::EventLoop; + use winit::window::Window; + + struct MyUserEvent; + + let event_loop = EventLoop::::with_user_event().build().unwrap(); + let window = event_loop.create_window(Window::default_attributes()).unwrap(); + let mut counter = 0; + + let _ = event_loop.run(move |event, event_loop| { + match event { + Event::AboutToWait => { + window.request_redraw(); + counter += 1; + } + Event::WindowEvent { window_id, event } => { + // Handle window event. + } + Event::UserEvent(event) => { + // Handle user event. + } + Event::DeviceEvent { device_id, event } => { + // Handle device event. + } + _ => (), + } + }); + ``` + + To migrate this code, you should move all the captured values into some + newtype `State` and implement `ApplicationHandler` for this type. Finally, + we move particular `match event` arms into methods on `ApplicationHandler`, + for example: + + ```rust,no_run + use winit::application::ApplicationHandler; + use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId}; + use winit::event_loop::{EventLoop, ActiveEventLoop}; + use winit::window::{Window, WindowId}; + + struct MyUserEvent; + + struct State { + window: Window, + counter: i32, + } + + impl ApplicationHandler for State { + fn user_event(&mut self, event_loop: &ActiveEventLoop, user_event: MyUserEvent) { + // Handle user event. + } + + fn resumed(&mut self, event_loop: &ActiveEventLoop) { + // Your application got resumed. + } + + fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) { + // Handle window event. + } + + fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) { + // Handle device event. + } + + fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) { + self.window.request_redraw(); + self.counter += 1; + } + } + + let event_loop = EventLoop::::with_user_event().build().unwrap(); + #[allow(deprecated)] + let window = event_loop.create_window(Window::default_attributes()).unwrap(); + let mut state = State { window, counter: 0 }; + + let _ = event_loop.run_app(&mut state); + ``` + + Please submit your feedback after migrating in [this issue](https://github.com/rust-windowing/winit/issues/3626). + +- Deprecate `Window::set_cursor_icon`, use `Window::set_cursor`. + +### Removed + +- Remove `Window::new`, use `ActiveEventLoop::create_window` instead. + + You now have to create your windows inside the actively running event loop + (usually the `new_events(cause: StartCause::Init)` or `resumed()` events), + and can no longer do it before the application has properly launched. + This change is done to fix many long-standing issues on iOS and macOS, and + will improve things on Wayland once fully implemented. + + To ease migration, we provide the deprecated `EventLoop::create_window` that + will allow you to bypass this restriction in this release. + + Using the migration example from above, you can change your code as follows: + + ```rust,no_run + use winit::application::ApplicationHandler; + use winit::event::{Event, WindowEvent, DeviceEvent, DeviceId}; + use winit::event_loop::{EventLoop, ActiveEventLoop}; + use winit::window::{Window, WindowId}; + + #[derive(Default)] + struct State { + // Use an `Option` to allow the window to not be available until the + // application is properly running. + window: Option, + counter: i32, + } + + impl ApplicationHandler for State { + // This is a common indicator that you can create a window. + fn resumed(&mut self, event_loop: &ActiveEventLoop) { + self.window = Some(event_loop.create_window(Window::default_attributes()).unwrap()); + } + fn window_event(&mut self, event_loop: &ActiveEventLoop, window_id: WindowId, event: WindowEvent) { + // `unwrap` is fine, the window will always be available when + // receiving a window event. + let window = self.window.as_ref().unwrap(); + // Handle window event. + } + fn device_event(&mut self, event_loop: &ActiveEventLoop, device_id: DeviceId, event: DeviceEvent) { + // Handle window event. + } + fn about_to_wait(&mut self, event_loop: &ActiveEventLoop) { + if let Some(window) = self.window.as_ref() { + window.request_redraw(); + self.counter += 1; + } + } + } + + let event_loop = EventLoop::new().unwrap(); + let mut state = State::default(); + let _ = event_loop.run_app(&mut state); + ``` + +- Remove `Deref` implementation for `EventLoop` that gave `EventLoopWindowTarget`. +- Remove `WindowBuilder` in favor of `WindowAttributes`. +- Remove Generic parameter `T` from `ActiveEventLoop`. +- Remove `EventLoopBuilder::with_user_event`, use `EventLoop::with_user_event`. +- Remove Redundant `EventLoopError::AlreadyRunning`. +- Remove `WindowAttributes::fullscreen` and expose as field directly. +- On X11, remove `platform::x11::XNotSupported` export. + +### Fixed + +- On Web, fix setting cursor icon overriding cursor visibility. +- On Windows, fix cursor not confined to center of window when grabbed and hidden. +- On macOS, fix sequence of mouse events being out of order when dragging on the trackpad. +- On Wayland, fix decoration glitch on close with some compositors. +- On Android, fix a regression introduced in #2748 to allow volume key events to be received again. +- On Windows, don't return a valid window handle outside of the GUI thread. +- On macOS, don't set the background color when initializing a window with transparency. diff --git a/src/platform/android.rs b/src/platform/android.rs index 5d13364b6f..5255a31870 100644 --- a/src/platform/android.rs +++ b/src/platform/android.rs @@ -19,6 +19,7 @@ //! //! | winit | ndk-glue | //! | :---: | :--------------------------: | +//! | 0.30 | `android-activity = "0.6"` | //! | 0.29 | `android-activity = "0.5"` | //! | 0.28 | `android-activity = "0.4"` | //! | 0.27 | `ndk-glue = "0.7"` | @@ -61,7 +62,7 @@ //! If your application is currently based on `NativeActivity` via the `ndk-glue` crate and building //! with `cargo apk`, then the minimal changes would be: //! 1. Remove `ndk-glue` from your `Cargo.toml` -//! 2. Enable the `"android-native-activity"` feature for Winit: `winit = { version = "0.29.15", +//! 2. Enable the `"android-native-activity"` feature for Winit: `winit = { version = "0.30.0", //! features = [ "android-native-activity" ] }` //! 3. Add an `android_main` entrypoint (as above), instead of using the '`[ndk_glue::main]` proc //! macro from `ndk-macros` (optionally add a dependency on `android_logger` and initialize