ext-image-capture-source-v1.xml RawHistoryFolder

1<?xml version="1.0" encoding="UTF-8"?>
2<protocol name="ext_image_capture_source_v1">
3  <copyright>
4    Copyright © 2022 Andri Yngvason
5    Copyright © 2024 Simon Ser
6
7    Permission is hereby granted, free of charge, to any person obtaining a
8    copy of this software and associated documentation files (the "Software"),
9    to deal in the Software without restriction, including without limitation
10    the rights to use, copy, modify, merge, publish, distribute, sublicense,
11    and/or sell copies of the Software, and to permit persons to whom the
12    Software is furnished to do so, subject to the following conditions:
13
14    The above copyright notice and this permission notice (including the next
15    paragraph) shall be included in all copies or substantial portions of the
16    Software.
17
18    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
21    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
23    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
24    DEALINGS IN THE SOFTWARE.
25  </copyright>
26
27  <description summary="opaque image capture source objects">
28    This protocol serves as an intermediary between capturing protocols and
29    potential image capture sources such as outputs and toplevels.
30
31    This protocol may be extended to support more image capture sources in the
32    future, thereby adding those image capture sources to other protocols that
33    use the image capture source object without having to modify those
34    protocols.
35
36    Warning! The protocol described in this file is currently in the testing
37    phase. Backward compatible changes may be added together with the
38    corresponding interface version bump. Backward incompatible changes can
39    only be done by creating a new major version of the extension.
40  </description>
41
42  <interface name="ext_image_capture_source_v1" version="1" frozen="true">
43    <description summary="opaque image capture source object">
44      The image capture source object is an opaque descriptor for a capturable
45      resource.  This resource may be any sort of entity from which an image
46      may be derived.
47
48      Note, because ext_image_capture_source_v1 objects are created from multiple
49      independent factory interfaces, the ext_image_capture_source_v1 interface is
50      frozen at version 1.
51    </description>
52
53    <request name="destroy" type="destructor">
54      <description summary="delete this object">
55        Destroys the image capture source. This request may be sent at any time
56        by the client.
57      </description>
58    </request>
59  </interface>
60
61  <interface name="ext_output_image_capture_source_manager_v1" version="1">
62    <description summary="image capture source manager for outputs">
63      A manager for creating image capture source objects for wl_output objects.
64    </description>
65
66    <request name="create_source">
67      <description summary="create source object for output">
68        Creates a source object for an output. Images captured from this source
69        will show the same content as the output. Some elements may be omitted,
70        such as cursors and overlays that have been marked as transparent to
71        capturing.
72      </description>
73      <arg name="source" type="new_id" interface="ext_image_capture_source_v1"/>
74      <arg name="output" type="object" interface="wl_output"/>
75    </request>
76
77    <request name="destroy" type="destructor">
78      <description summary="delete this object">
79        Destroys the manager. This request may be sent at any time by the client
80        and objects created by the manager will remain valid after its
81        destruction.
82      </description>
83    </request>
84  </interface>
85
86  <interface name="ext_foreign_toplevel_image_capture_source_manager_v1" version="1">
87    <description summary="image capture source manager for foreign toplevels">
88      A manager for creating image capture source objects for
89      ext_foreign_toplevel_handle_v1 objects.
90    </description>
91
92    <request name="create_source">
93      <description summary="create source object for foreign toplevel">
94        Creates a source object for a foreign toplevel handle. Images captured
95        from this source will show the same content as the toplevel.
96      </description>
97      <arg name="source" type="new_id" interface="ext_image_capture_source_v1"/>
98      <arg name="toplevel_handle" type="object" interface="ext_foreign_toplevel_handle_v1"/>
99    </request>
100
101    <request name="destroy" type="destructor">
102      <description summary="delete this object">
103        Destroys the manager. This request may be sent at any time by the client
104        and objects created by the manager will remain valid after its
105        destruction.
106      </description>
107    </request>
108  </interface>
109</protocol>