Skip to content
Federico Di Pierro edited this page Jun 7, 2023 · 6 revisions

Since Clightd 5.0, Screen API exposes 3 different plugins (priority-listed below):

  • /org/clightd/clightd/Screen/Xorg
  • /org/clightd/clightd/Screen/Wl
  • /org/clightd/clightd/Screen/Fb

When calling any of those, their plugin will be used; when calling main object path first available plugin will be used instead given the above priority-listed list.

The API is the same for any of those plugins; but first 2 input parameters ("ss") meaning changes:

Xorg

  • $DISPLAY (defaults to ":0")
  • $XAUTHORITY (defaults to caller "$HOME/.Xauthority")

Wl

  • $WAYLAND_DISPLAY (defaults to "wayland-0")
  • $XDG_RUNTIME_DIR (defaults to caller "/run/user/$uid")

Support on wayland requires the compositor to implement wlr-screencopy-unstable-v1 protocol.

Fb

  • framebuffer device (if empty defaults to first graphics device it finds through udev)
  • unused
Clone this wiki locally