ws: Save and expose damaged image regions (v2) #188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The wl_surface.damage_buffer request can be used by clients to inform that a given region (in buffer coordinates) is damaged. This request is used by eglSwapBuffersWithDamage[EXT|KHR], with one call for each rect. For more info: https://wayland-book.com/surfaces-in-depth/damaging-surfaces.html This commit stores this information and exposes it to exported EGL image clients. It also bumps the nested compositor interface to version 4, which provides the damage_buffer support.
Use the wl_surface_interface::damage_buffer member unconditionally, checking that the definition is available from Meson at configuration time.
Clear the list of damage rectangles when a surface is destroyed, to avoid leaking them and slowly filling the damage map with unneeded, stale entries.
Instead of a series of groups of four integer values, group each damage entry in a wpe_fdo_rect instance, which defines a rectangle explicitly documented to use the origin of coordinates at the top-left corner of exported images. This approach is more readable, uses the same amount of memory, allows defining the wpe_fdo_egl_exported_image_get_damage_regions() function in a more idiomatic way (returning pointer to rect array, and receiving a pointer where to store the number of entries), simplifies the code that returns the damage rectangle list, and also the code that stores a damage rectangle (also improved by using emplace+move). While at it, document wpe_fdo_egl_exported_image_get_damage_regions() and the new wpe_fdo_rect type.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This builds upon #184, with the following additions:
wl_surface_damage_buffer(), erroring if not available. The functionality is now always built-in. This should not be an issue because any reasonable Wayland version should have it.unordered_mapthat associates a buffer with its damaged regions list when a buffer is destroyed.wpe_fdo_recttype, which makes the code easier to follow, and documents the damage support, explicitly indicating that top-left is used as origin of coordinates for damage.wl_surface_interfaceends up being used.Thanks to @lauromoura for the first version of the patch set 🙏🏼