Skip to content

Commit 0e4cc52

Browse files
committed
feat(weston): describe how to take screenshots
Describe how to take screenshots and the required configuration steps beforehand. Signed-off-by: Randolph Sapp <[email protected]>
1 parent 1132a08 commit 0e4cc52

File tree

1 file changed

+16
-0
lines changed
  • source/linux/Foundational_Components/Graphics/Common

1 file changed

+16
-0
lines changed

source/linux/Foundational_Components/Graphics/Common/Weston.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,3 +253,19 @@ See the following for more information about the Weston IVI-shell:
253253

254254
- `<https://wayland.pages.freedesktop.org/weston/toc/ivi-shell.html>`_
255255

256+
***********
257+
Screenshots
258+
***********
259+
260+
The :command:`weston-screenshooter` utility allows for fast, full-screen
261+
screenshots. It behaves similarly to any other weston client utility and
262+
requires the ``WAYLAND_DISPLAY`` environment variable to point to a valid
263+
Wayland socket. See :ref:`running-weston-clients` for more information.
264+
265+
For most Wayland compositors this would be enough, but Weston requires
266+
additional configuration. Weston does not support the `screen capture
267+
protocol`_, and instead uses an internal helper to fetch and dump active display
268+
contents. Weston only exposes this helper when launched in debug mode. To do
269+
this, add the ``--debug`` argument when starting Weston.
270+
271+
.. _screen capture protocol: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml

0 commit comments

Comments
 (0)