diff options
Diffstat (limited to 'unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml')
| -rw-r--r-- | unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml b/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml index 99d3b51..3b4861f 100644 --- a/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml +++ b/unstable/linux-dmabuf/linux-dmabuf-unstable-v1.xml @@ -56,11 +56,11 @@ sub-system that might accept it. To create a wl_buffer from one or more dmabufs, a client creates a - zwp_linux_dmabuf_params_v1 object with zwp_linux_dmabuf_v1.create_params + zwp_linux_dmabuf_params_v1 object with a zwp_linux_dmabuf_v1.create_params request. All planes required by the intended format are added with - the 'add' request. Finally, 'create' request is issued. The server - will reply with either 'created' event which provides the final - wl_buffer or 'failed' event saying that it cannot use the dmabufs + the 'add' request. Finally, a 'create' request is issued. The server + will reply with either a 'created' event which provides the final + wl_buffer or a 'failed' event saying that it cannot use the dmabufs provided. Warning! The protocol described in this file is experimental and @@ -84,7 +84,7 @@ <description summary="create a temporary object for buffer parameters"> This temporary object is used to collect multiple dmabuf handles into a single batch to create a wl_buffer. It can only be used once and - should be destroyed after an 'created' or 'failed' event has been + should be destroyed after a 'created' or 'failed' event has been received. </description> <arg name="params_id" type="new_id" interface="zwp_linux_buffer_params_v1" @@ -95,7 +95,7 @@ <description summary="supported buffer format"> This event advertises one buffer format that the server supports. All the supported formats are advertised once when the client - binds to this interface. A roundtrip after binding guarantees, + binds to this interface. A roundtrip after binding guarantees that the client has received all supported formats. For the definition of the format codes, see create request. @@ -104,7 +104,6 @@ </description> <arg name="format" type="uint" summary="DRM_FORMAT code"/> </event> - </interface> <interface name="zwp_linux_buffer_params_v1" version="1"> @@ -116,7 +115,7 @@ Single-planar formats only require one dmabuf, however multi-planar formats may require more than one dmabuf. For all - formats, 'add' request must be called once per plane (even if the + formats, an 'add' request must be called once per plane (even if the underlying dmabuf fd is identical). You must use consecutive plane indices ('plane_idx' argument for 'add') @@ -244,7 +243,7 @@ This request can be sent only once in the object's lifetime, after which the only legal request is destroy. This object should be - destroyed after issuing 'create' request. Attempting to use this + destroyed after issuing a 'create' request. Attempting to use this object after issuing 'create' raises ALREADY_USED protocol error. It is not mandatory to issue 'create'. If a client wants to @@ -278,7 +277,6 @@ zlinux_buffer_params object. </description> </event> - </interface> </protocol> |