[PATCH] protocol: deprecate wl_surface.damage

Simon Ser contact at emersion.fr
Sun Nov 4 08:38:16 UTC 2018


This commit deprecates wl_surface.damage in favor of wl_surface.damage_buffer.

Having two requests makes it complicated for the compositor to handle damage,
making it necessary to transform one into the other's coordinates.

Moreover, integration with wp_viewporter is tricky.

Signed-off-by: Simon Ser <contact at emersion.fr>
---

Based on the discussion in [1].

[1]: https://gitlab.freedesktop.org/wayland/weston/merge_requests/41#note_74071

 protocol/wayland.xml | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/protocol/wayland.xml b/protocol/wayland.xml
index 141038b..c75ea3a 100644
--- a/protocol/wayland.xml
+++ b/protocol/wayland.xml
@@ -1397,9 +1397,9 @@
 	and clears pending damage. The server will clear the current
 	damage as it repaints the surface.
 
-	Alternatively, damage can be posted with wl_surface.damage_buffer
-	which uses buffer coordinates instead of surface coordinates,
-	and is probably the preferred and intuitive way of doing this.
+	Note! This request is deprecated and should not be used in new
+	clients. Instead damage can be posted with wl_surface.damage_buffer
+	which uses buffer coordinates instead of surface coordinates.
       </description>
       <arg name="x" type="int" summary="surface-local x coordinate"/>
       <arg name="y" type="int" summary="surface-local y coordinate"/>
-- 
2.19.1




More information about the wayland-devel mailing list