wlroots 0.15.0

[emersion]

Planning for the next release.

Milestone: https://github.com/swaywm/wlroots/milestone/8

---

wlroots has migrated to gitlab.freedesktop.org. This issue has been moved to:

https://gitlab.freedesktop.org/wlroots/wlroots/-/issues/2983

[emersion]

Changes for packagers

• backend: make DRM and libinput backends optional (backend: make DRM and libinput backends optional #3058): the x11-backend build option has been superseded by the backends option.

Breaking changes for compositors

These changes can affect most compositors.

• Stabilize wlr_box API (Stabilize wlr_box API #3011)
  • wlr_box_from_pixman_box32 and wlr_box_rotated_bounds have been removed.
  • wlr/types/wlr_box.h has been moved to wlr/util/box.h (a redirection with a warning is still in place).
  • Unnecessary wlr_box.h includes have been replaced with forward declarations in public wlroots headers.
• backend/drm: preserve mode order from kernel (backend/drm: preserve mode order from kernel #3078): the order of wlr_output.modes has been reversed for the DRM backend to match the kernel's ordering. Compositors are advised to use wlr_output_preferred_mode instead of relying on mode order.
• layer-shell: replace close() with destroy() (layer-shell: replace close() with destroy()  #3108): replace wlr_layer_surface_v1_close calls with wlr_layer_surface_v1_destroy and ensure the wlr_layer_surface_v1 isn't used after that call.
• xwm: do not restack surfaces on activation (xwm: do not restack surfaces on activation  #2915): wlr_xwayland_surface_activate no longer brings windows to the front. Compositors now need to explicitly call wlr_xwayland_surface_restack(xsurface, NULL, XCB_STACK_MODE_ABOVE).
• Minor surface refactor (Minor surface refactor #3169):
  • wlr_subsurface.parent_link has been replaced with wlr_subsurface.current.link; same goes for wlr_subsurface.parent_pending_link.
  • wlr_surface.subsurfaces_{above,below} has been moved to wlr_surface_state, use wlr_surface.current.subsurfaces_{above,below}.
• xdg-toplevel: refactor configure/state flow (xdg-toplevel: refactor configure/state flow #3199): compositors that used to check wlr_xdg_toplevel.client_pending will now have to check wlr_xdg_toplevel.requested.
• xdg-shell: introduce wlr_xdg_surface_state (xdg-shell: introduce wlr_xdg_surface_state #3106):
  • wlr_xdg_surface.configure_next_serial has been renamed to wlr_xdg_surface.scheduled_serial.
  • wlr_xdg_surface.configure_serial has been moved into wlr_xdg_surface_state and is double-buffered.
  • wlr_xdg_surface.geometry and wlr_xdg_surface.next_geometry have been replaced with wlr_xdg_surface.current.geometry and wlr_xdg_surface.pending.geometry respectively.
  • wlr_xdg_surface.has_next_geometry has been removed.
• layer-shell: refactor configure/state flow (layer-shell: refactor configure/state flow #3201):
  • compositors that used to check wlr_layer_surface_v1.client_pending will now have to check wlr_layer_surface_v1.pending.
  • wlr_layer_surface_v1_configure() now returns the configure serial, wlr_layer_surface_v1.configure_next_serial has been removed.
  • wlr_layer_surface_v1.configure_serial has been moved into wlr_layer_surface_v1_state and is double-buffered.
• xdg-decoration: refactor configure/state flow (xdg-decoration: refactor configure/state flow #3228)
  • wlr_xdg_toplevel_decoration_v1.client_pending_mode has been renamed to wlr_xdg_toplevel_decoration_v1.requested_mode.
  • wlr_xdg_toplevel_decoration_v1.server_pending_mode has been renamed to wlr_xdg_toplevel_decoration_v1.scheduled_mode.
  • wlr_xdg_toplevel_decoration_v1.current_mode has been moved to wlr_xdg_toplevel_decoration_v1_state and is double-buffered.
• backend: create renderer and allocator in wlr_backend_autocreate (backend: create renderer and allocator in wlr_backend_autocreate #3222): wlr_backend_get_renderer can now fail if wlr_backend_autocreate isn't used and the renderer couldn't be initialized.
• *_for_each_surface and *_surface_at: skip unmapped surfaces (for_each_surface and surface_at: skip unmapped surfaces #3220): for compositors which only use *_for_each_surface for rendering, this should fix bugs. For compositors which really mean to iterate over all surfaces in the tree regardless of their mapped status, the function needs to be manually re-implemented.

Breaking changes for custom backends and renderers

These changes are unlikely to affect compositors that don't have a custom
backend or renderer.

• render/egl: make most functions private (render/egl: make most functions private #2985)
• surface: make wlr_subsurface_create private (surface: make wlr_subsurface_create private #2993)
• render: drop wlr_renderer_impl.texture_from_{pixels,dmabuf} (render: drop wlr_renderer_impl.texture_from_{pixels,dmabuf} #2997)
• Nuke wlr_list (Nuke wlr_list #3002): wlr/types/wlr_list.h has been removed. wlr_tablet.paths and wlr_tablet_pad.paths are now wl_array instead of wlr_list.
• Remove wlr_resource_get_buffer_size (Remove wlr_resource_get_buffer_size #3023)
  • wlr_resource_get_buffer_size has been removed.
  • wlr_client_buffer_import has been split into two functions: wlr_buffer_from_resource and wlr_client_buffer_create.
• buffer: drop wlr_client_buffer.resource (buffer: drop wlr_client_buffer.resource #3039)
• output: add generic wlr_output_export_dmabuf implementation (output: add generic wlr_output_export_dmabuf implementation  #2955): wlr_output_impl.export_dmabuf has been dropped.
• render: drop wlr_renderer_impl.init_wl_display (render: drop wlr_renderer_impl.init_wl_display #3062)
• Drop legacy output APIs (Drop legacy output APIs #3044): wlr_output_impl.{attach,rollback}_render and wlr_output_state.buffer_type have been removed.
• surface: drop wlr_surface_state.buffer_resource (surface: drop wlr_surface_state.buffer_resource #3105): use wlr_surface_state.buffer instead.
• buffer: add data_ptr access flags (buffer: add data_ptr access flags #2994): wlr_buffer_impl.begin_data_ptr_access now takes a new flags argument.
• output: add presented flag to presentation event (output: add presented flag to presentation event #3245): wlr_output_send_present() doesn't accept NULL events anymore; wlr_output_event_present now has a presented flag which must be set to true if the buffer was presented to a user.