protocol: Add test screenshot capability

This adds a capture_screenshot request which returns an image of the
screen in the client-supplied wl_buffer for the given display output.

A 'done' event is used to indicate when screenshotting has finished and
the wl_buffer is ready to be read.

Signed-off-by: Bryce Harrington <bryce@osg.samsung.com>
Reviewed-By: Derek Foreman <derekf@osg.samsung.com>

diff --git a/protocol/weston-test.xml b/protocol/weston-test.xml
index 643a0c7..2fd6b7a 100644 (file)
--- a/protocol/weston-test.xml
+++ b/protocol/weston-test.xml
@@ -73,6 +73,22 @@
     <event name="n_egl_buffers">
       <arg name="n" type="uint"/>
     </event>
+    <request name="capture_screenshot">
+      <description summary="records current screen image">
+        Records an image of what is currently displayed on a given
+        display output, returning the image as an event.
+      </description>
+      <arg name="output" type="object" interface="wl_output"
+           summary="output to capture from"/>
+      <arg name="buffer" type="object" interface="wl_buffer"
+           summary="buffer for returning screenshots to the test client"/>
+    </request>
+    <event name="capture_screenshot_done">
+         <description summary="screenshot capture is done">
+               The capture_screenshot_done signal is sent when a screenshot has been copied into the
+               provided buffer.
+         </description>
+    </event>
   </interface>
 
   <interface name="weston_test_runner" version="1">