Skip to content

Feature/screenshot #499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StaticRocket merged 2 commits into from
Oct 24, 2025
Merged

Feature/screenshot #499

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20cc061
feat(weston): describe the weston session entry
StaticRocket Oct 22, 2025
a07f2e4
feat(weston): describe how to take screenshots
StaticRocket Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions source/linux/Foundational_Components/Graphics/Common/Weston.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@
specified graphical environment. By default it will automatically start
``weston`` under the weston user on device startup.

The definition of the session, including the command used to start it is in
:file:`/usr/share/wayland-sessions/weston.desktop`. This follows the desktop

Check warning on line 58 in source/linux/Foundational_Components/Graphics/Common/Weston.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'sessions/weston'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'sessions/weston'", "location": {"path": "source/linux/Foundational_Components/Graphics/Common/Weston.rst", "range": {"start": {"line": 58, "column": 27}}}, "severity": "WARNING"}
entry initialization (INI) format. Some have argued that session entries do not
fully meet the `Desktop Entry Specification`_ due to the addition of some new
keys and silent disregard of other keys.

.. _Desktop Entry Specification: https://specifications.freedesktop.org/desktop-entry-spec

If you need to interact with this instance with any other user, then make sure
that user is capable of interacting with the wayland socket. This will be
:file:`wayland-1` under the ``weston`` user's ``XDG_RUNTIME_DIR``,
Expand Down Expand Up @@ -245,3 +253,19 @@

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

***********
Screenshots
***********

The :command:`weston-screenshooter` utility allows for fast, full-screen
screenshots. It behaves similarly to any other weston client utility and
requires the ``WAYLAND_DISPLAY`` environment variable to point to a valid
Wayland socket. See :ref:`running-weston-clients` for more information.

For most Wayland compositors this would be enough, but Weston requires
additional configuration. Weston does not support the `screen capture
protocol`_, and instead uses an internal helper to fetch and dump active display
contents. Weston only exposes this helper when launched in debug mode. To do
this, add the ``--debug`` argument when starting Weston.

.. _screen capture protocol: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/blob/main/staging/ext-image-copy-capture/ext-image-copy-capture-v1.xml