Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.71 KB

unreleased.md

File metadata and controls

59 lines (40 loc) · 1.71 KB
Raw

The format is based on Keep a Changelog.

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:

### 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`.

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:

- 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.

Unreleased

Changed

  • On Web, let events wake up event loop immediately when using ControlFlow::Poll.

Fixed

  • On Web, fix EventLoopProxy::send_event() triggering event loop immediately when not called from inside the event loop. Now queues a microtask instead.
  • On Web, stop overwriting default cursor with CursorIcon::Default.
  • On Web, prevent crash when using InnerSizeWriter::request_inner_size().

Removed

  • Remove EventLoop::run.
  • Remove EventLoopExtRunOnDemand::run_on_demand.
  • Remove EventLoopExtPumpEvents::pump_events.