[PATCH v2] protocol: prefer wl_surface.damage_buffer

[Derek Foreman]

On 11/5/18 1:44 PM, Derek Foreman wrote:
> On 11/5/18 7:57 AM, Simon Ser wrote:
>> This commit makes wl_surface.damage_buffer preferred over wl_surface.damage.
>> wl_surface.damage can be implemented in a non-optimal way by the compositor
>> (e.g. by always damaging the whole 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>
> 
> Obnoxious nitpick: for some reason that file uses different formatting
> than others in the repo, and 8 spaces are compressed into a single tab.
> 
> Otherwise, this is:
> Reviewed-by: Derek Foreman <derek.foreman.samsung at gmail.com>

This is landed now, I changed the formatting to match the surrounding
text when I did so.

Thanks!
Derek

>> ---
>>  protocol/wayland.xml | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/protocol/wayland.xml b/protocol/wayland.xml
>> index 141038b..df2b6d2 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! New clients should not use this request. 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"/>
>>
>