2024-04-12 21:38:50 +04:00
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
|
|
|
|
|
|
|
|
|
The sections should follow the order `Added`, `Changed`, `Deprecated`,
|
|
|
|
|
`Removed`, and `Fixed`.
|
|
|
|
|
|
|
|
|
|
Platform specific changed should be added to the end of the section and grouped
|
|
|
|
|
by platform name. Common API additions should have `, implemented` at the end
|
|
|
|
|
for platforms where the API was initially implemented. See the following example
|
|
|
|
|
on how to add them:
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
### Added
|
|
|
|
|
|
|
|
|
|
- Add `Window::turbo()`, implemented on X11, Wayland, and Web.
|
|
|
|
|
- On X11, add `Window::some_rare_api`.
|
|
|
|
|
- On X11, add `Window::even_more_rare_api`.
|
|
|
|
|
- On Wayland, add `Window::common_api`.
|
|
|
|
|
- On Windows, add `Window::some_rare_api`.
|
|
|
|
|
```
|
|
|
|
|
|
2024-04-12 21:55:44 +04:00
|
|
|
When the change requires non-trivial amount of work for users to comply
|
|
|
|
|
with it, the migration guide should be added below the entry, like:
|
|
|
|
|
|
|
|
|
|
```md
|
|
|
|
|
- Deprecate `Window` creation outside of `EventLoop::run`
|
|
|
|
|
|
|
|
|
|
This was done to simply migration in the future. Consider the
|
|
|
|
|
following code:
|
|
|
|
|
|
|
|
|
|
// Code snippet.
|
|
|
|
|
|
|
|
|
|
To migrate it we should do X, Y, and then Z, for example:
|
|
|
|
|
|
|
|
|
|
// Code snippet.
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The migration guide could reference other migration examples in the current
|
|
|
|
|
changelog entry.
|
|
|
|
|
|
2024-02-16 17:28:13 +01:00
|
|
|
## Unreleased
|
2024-05-06 16:29:07 +02:00
|
|
|
|
2024-06-29 17:19:09 +02:00
|
|
|
### Added
|
|
|
|
|
|
|
|
|
|
- Add `ActiveEventLoop::create_proxy()`.
|
2024-07-17 02:33:06 +02:00
|
|
|
- On Web, implement `Error` for `platform::web::CustomCursorError`.
|
2024-06-29 17:19:09 +02:00
|
|
|
|
2024-06-12 00:02:26 +02:00
|
|
|
### Changed
|
|
|
|
|
|
2024-06-21 21:40:16 +03:00
|
|
|
- On Web, let events wake up event loop immediately when using `ControlFlow::Poll`.
|
2024-06-20 11:09:15 +02:00
|
|
|
- Bump MSRV from `1.70` to `1.73`.
|
2024-06-24 13:04:55 +03:00
|
|
|
- Changed `ApplicationHandler::user_event` to `user_wake_up`, removing the
|
|
|
|
|
generic user event.
|
|
|
|
|
|
|
|
|
|
Winit will now only indicate that wake up happened, you will have to pair
|
|
|
|
|
this with an external mechanism like `std::sync::mpsc::channel` if you want
|
|
|
|
|
to send specific data to be processed on the main thread.
|
|
|
|
|
- Changed `EventLoopProxy::send_event` to `EventLoopProxy::wake_up`, it now
|
|
|
|
|
only wakes up the loop.
|
2024-07-21 18:39:43 +02:00
|
|
|
- On X11, implement smooth resizing through the sync extension API.
|
2024-06-30 00:41:57 +02:00
|
|
|
- `ApplicationHandler::create|destroy_surfaces()` was split off from
|
|
|
|
|
`ApplicationHandler::resumed/suspended()`.
|
|
|
|
|
|
|
|
|
|
`ApplicationHandler::can_create_surfaces()` should, for portability reasons
|
|
|
|
|
to Android, be the only place to create render surfaces.
|
|
|
|
|
|
|
|
|
|
`ApplicationHandler::resumed/suspended()` are now only emitted by iOS and Web
|
|
|
|
|
and now signify actually resuming/suspending the application.
|
2024-07-10 16:17:39 +02:00
|
|
|
- Rename `platform::web::*ExtWebSys` to `*ExtWeb`.
|
2024-07-11 15:38:09 +02:00
|
|
|
- Change signature of `EventLoop::run_app`, `EventLoopExtPumpEvents::pump_app_events` and
|
|
|
|
|
`EventLoopExtRunOnDemand::run_app_on_demand` to accept a `impl ApplicationHandler` directly,
|
|
|
|
|
instead of requiring a `&mut` reference to it.
|
2024-06-12 00:02:26 +02:00
|
|
|
|
2024-05-20 20:27:36 +04:00
|
|
|
### Removed
|
|
|
|
|
|
|
|
|
|
- Remove `EventLoop::run`.
|
|
|
|
|
- Remove `EventLoopExtRunOnDemand::run_on_demand`.
|
|
|
|
|
- Remove `EventLoopExtPumpEvents::pump_events`.
|
2024-06-24 13:04:55 +03:00
|
|
|
- Remove `Event`.
|
2024-06-24 22:56:20 +02:00
|
|
|
- On iOS, remove `platform::ios::EventLoopExtIOS` and related `platform::ios::Idiom` type.
|
|
|
|
|
|
|
|
|
|
This feature was incomplete, and the equivalent functionality can be trivially achieved outside
|
|
|
|
|
of `winit` using `objc2-ui-kit` and calling `UIDevice::currentDevice().userInterfaceIdiom()`.
|
2024-07-17 10:38:30 +02:00
|
|
|
- On Web, remove unused `platform::web::CustomCursorError::Animation`.
|