diff options
Diffstat (limited to 'protocol/wlr-export-dmabuf-unstable-v1.xml')
| -rw-r--r-- | protocol/wlr-export-dmabuf-unstable-v1.xml | 117 |
1 files changed, 33 insertions, 84 deletions
diff --git a/protocol/wlr-export-dmabuf-unstable-v1.xml b/protocol/wlr-export-dmabuf-unstable-v1.xml index ab9694a6..760345a7 100644 --- a/protocol/wlr-export-dmabuf-unstable-v1.xml +++ b/protocol/wlr-export-dmabuf-unstable-v1.xml @@ -42,26 +42,21 @@ fetched and used. The receive callback shall be called first, followed by the "object" - callback once per dmabuf object or the "layer" callback, once per dmabuf - layer. The "plane" callback shall only be called after the "layer" - callback corresponding to the layer the plane belongs to has been called - Finally, the "ready" event is called to indicate that all the data has + callback once per dmabuf object or the "plane" callback, once per dmabuf + plane. The "ready" event is called last to indicate that all the data has been made available for readout, as well as the time at which presentation happened at. The ownership of the frame is passed to the client, who's - responsible for destroying it via the "destroy" event once finished. - The data the API describes has been based off of what - VASurfaceAttribExternalBuffers contains. + responsible for destroying it via the "destroy" event once finished and + by calling close() on the file descriptors received. All frames are read-only and may not be written into or altered. </description> <enum name="flags"> <description summary="frame flags"> - Special flags that must be respected by the client. - Transient frames indicate short lifetime frames (such as swapchain - images from external clients). Clients are advised to copy them and do - all processing outside of the "ready" event. + Special flags that should be respected by the client. </description> - <entry name="transient" value="0x1" since="1"/> + <entry name="transient" value="0x1" since="1" + summary="clients should copy frame before processing"/> </enum> <event name="frame"> @@ -79,24 +74,25 @@ summary="frame width, scaling factor included"/> <arg name="height" type="uint" summary="frame height, scaling factor included"/> - <arg name="scale" type="uint" - summary="current scaling factor of the client"/> - <arg name="transform" type="uint" - summary="transform needed to correct the orientation, has the same - values as wl_output::transform"/> + <arg name="offset_x" type="uint" + summary="crop offset for the x axis"/> + <arg name="offset_y" type="uint" + summary="crop offset for the y axis"/> <arg name="buffer_flags" type="uint" summary="flags which indicate properties (invert, interlacing), has the same values as zwp_linux_buffer_params_v1:flags"/> <arg name="flags" type="uint" enum="flags" summary="indicates special frame features"/> + <arg name="format" type="uint" + summary="format of the frame (DRM_FORMAT_*)"/> <arg name="mod_high" type="uint" summary="drm format modifier, high"/> <arg name="mod_low" type="uint" summary="drm format modifier, low"/> <arg name="num_objects" type="uint" summary="indicates how many objects (FDs) the frame has (max 4)"/> - <arg name="num_layers" type="uint" - summary="indicates how many layers the frame has (max 4)"/> + <arg name="num_planes" type="uint" + summary="indicates how many planes the frame has (max 4)"/> </event> <event name="object"> <description summary="object receiving callback"> @@ -110,28 +106,13 @@ <arg name="size" type="uint" summary="size in bytes for the current object"/> </event> - <event name="layer"> - <description summary="layer receiving callback"> - Callback which serves to supply the client with information on what's - contained in each file descriptor and how its laid out. - Will be called after the main receive event, once per layer. - </description> - <arg name="index" type="uint" - summary="index of the current plane"/> - <arg name="format" type="uint" - summary="format of the layer (DRM_FORMAT_*)"/> - <arg name="num_planes" type="uint" - summary="number of planes in the current layer (max 4)"/> - </event> <event name="plane"> <description summary="plane info receiving callback"> Callback which supplies the client with plane information for each - layer. + plane. </description> <arg name="index" type="uint" summary="index of the current plane"/> - <arg name="layer_index" type="uint" - summary="index of the current layer"/> <arg name="object_index" type="uint" summary="index of the object the plane applies to"/> <arg name="offset" type="uint" @@ -158,21 +139,19 @@ summary="nanoseconds part of the timestamp"/> </event> - <enum name="abort_reason"> - <description summary="abort reason"> - Indicates reason for aborting the frame. + <enum name="cancel_reason"> + <description summary="cancel reason"> + Indicates reason for cancelling the frame. </description> - <entry name="invalid_source" value="0" since="1" - summary="invalid source, will not produce any (more) frames"/> - <entry name="resizing" value="1" since="1" - summary="source started being resized, this frame must be dropped, - but source is still able to be captured"/> - <entry name="security" value="2" since="1" - summary="this frame must be dropped as sensitive data was present, - however future capture may still succeed"/> + <entry name="temporary" value="0" since="1" + summary="temporary error, source will produce more frames"/> + <entry name="pernament" value="1" since="1" + summary="fatal error, source will not produce frames"/> + <entry name="resizing" value="2" since="1" + summary="temporary error, source will produce frames"/> </enum> - <event name="abort"> + <event name="cancel"> <description summary="indicates the frame is no longer valid"> If the frame is no longer valid after the "frame" event has been called, this callback will be used to inform the client to scrap the frame. @@ -181,57 +160,27 @@ This may get called if for instance the surface is in the process of resizing. </description> - <arg name="reason" type="uint" enum="abort_reason" - summary="indicates a reason for aborting this frame capture"/> + <arg name="reason" type="uint" enum="cancel_reason" + summary="indicates a reason for cancelling this frame capture"/> </event> <request name="destroy" type="destructor"> <description summary="delete this object, used or not"> Unreferences the frame, allowing it to be reused. Must be called as soon as its no longer used. + Can be called at any time by the client after the "frame" event, after + which the compositor will not call any other events unless the client + resubscribes to capture more. The client will still have to close any + FDs it has been given. </description> </request> </interface> <interface name="zwlr_export_dmabuf_manager_v1" version="1"> <description summary="manager to inform clients and begin capturing"> - This object is a manager which informs clients about capturable windows - and is able to create callbacks from which to begin to receive content - from. The "title" argument in the "surface_info" event shall be used - to provide a user-readable identifier such as a window title or - program name. + This object is a manager with which to start capturing from sources. </description> - <event name="surface_info"> - <description summary="get valid surfaces for capture"> - This will be called whenever a surface that's able to be captured - appears. - </description> - <arg name="title" type="string" - summary="window title or an identifier"/> - <arg name="id" type="uint" - summary="an identifier to create a context with"/> - </event> - <event name="surface_unavailable"> - <description summary="notifies of a surface being unavailable to capture"> - Called if a surface becomes unavailable to capture, for example if has - been closed. - </description> - <arg name="id" type="uint" - summary="an identifier of the surface"/> - </event> - - <request name="capture_client"> - <description summary="subscribe to start capturing"> - Request to start capturing from a surface with a given id. - </description> - <arg name="frame" type="new_id" - interface="zwlr_export_dmabuf_frame_v1"/> - <arg name="overlay_cursor" type="int" - summary="include custom client hardware cursor on top of the frame"/> - <arg name="id" type="uint" - summary="an identifier to start capturing from"/> - </request> <request name="capture_output"> <description summary="subscribe to start capturing"> Request to start capturing from an entire wl_output. |