protocol: add note about wl_buffer/wl_callback version
authorSimon Ser <contact@emersion.fr>
Mon, 5 Dec 2022 17:29:23 +0000 (18:29 +0100)
committerSimon Ser <contact@emersion.fr>
Wed, 7 Dec 2022 09:04:49 +0000 (10:04 +0100)
This is an exception which can be confusing. Add an explicit note
about it in the protocol text.

Signed-off-by: Simon Ser <contact@emersion.fr>
protocol/wayland.xml

index a94e85c..440ecd8 100644 (file)
     <description summary="callback object">
       Clients can handle the 'done' event to get notified when
       the related request is done.
+
+      Note, because wl_callback objects are created from multiple independent
+      factory interfaces, the wl_callback interface is frozen at version 1.
     </description>
 
     <event name="done" type="destructor">
       If the buffer uses a format that has an alpha channel, the alpha channel
       is assumed to be premultiplied in the color channels unless otherwise
       specified.
+
+      Note, because wl_buffer objects are created from multiple independent
+      factory interfaces, the wl_buffer interface is frozen at version 1.
     </description>
 
     <request name="destroy" type="destructor">