aboutsummaryrefslogtreecommitdiff
path: root/protocol/wlr-screencopy-unstable-v1.xml
diff options
context:
space:
mode:
authoremersion <contact@emersion.fr>2018-06-23 15:12:17 +0100
committeremersion <contact@emersion.fr>2018-06-30 22:18:04 +0100
commitbf7560b7cda5d3df8cdc7d24e969bfd91cf0ded5 (patch)
treea1ffd0940e5237b72cbdc3a3486bcd63a3387ceb /protocol/wlr-screencopy-unstable-v1.xml
parent2b9cbaddf3d285ce439bd5da9f19995a0ddbac3a (diff)
screencopy: add capture_output_region support
Diffstat (limited to 'protocol/wlr-screencopy-unstable-v1.xml')
-rw-r--r--protocol/wlr-screencopy-unstable-v1.xml29
1 files changed, 26 insertions, 3 deletions
diff --git a/protocol/wlr-screencopy-unstable-v1.xml b/protocol/wlr-screencopy-unstable-v1.xml
index e62e3ff0..c54b7268 100644
--- a/protocol/wlr-screencopy-unstable-v1.xml
+++ b/protocol/wlr-screencopy-unstable-v1.xml
@@ -43,14 +43,37 @@
source.
</description>
+ <enum name="error">
+ <entry name="invalid_output_region" value="0"
+ summary="tried to capture an invalid output region"/>
+ </enum>
+
<request name="capture_output">
- <description summary="start capturing">
- Capture the next frame of a an entire output.
+ <description summary="capture an output">
+ Capture the next frame of an entire output.
+ </description>
+ <arg name="frame" type="new_id" interface="zwlr_screencopy_frame_v1"/>
+ <arg name="overlay_cursor" type="int"
+ summary="composite cursor onto the frame"/>
+ <arg name="output" type="object" interface="wl_output"/>
+ </request>
+
+ <request name="capture_output_region">
+ <description summary="capture an output's region">
+ Capture the next frame of an output's region.
+
+ The region is given in output logical coordinates, see
+ xdg_output.logical_size. Trying to capture a region spanning outside the
+ output extents is a protocol error.
</description>
<arg name="frame" type="new_id" interface="zwlr_screencopy_frame_v1"/>
<arg name="overlay_cursor" type="int"
- summary="include custom client hardware cursor on top of the frame"/>
+ summary="composite cursor onto the frame"/>
<arg name="output" type="object" interface="wl_output"/>
+ <arg name="x" type="int"/>
+ <arg name="y" type="int"/>
+ <arg name="width" type="int"/>
+ <arg name="height" type="int"/>
</request>
<request name="destroy" type="destructor">