|xdg-desktop-portal-wlr(5)||File Formats Manual||xdg-desktop-portal-wlr(5)|
xdg-desktop-portal-wlr - an xdg-desktop-portal backend for wlroots
xdg-desktop-portal-wlr (or xdpw for short) allows applications to request screenshots and screencasts via xdg-desktop-portal in wlroots-based Wayland compositors.
xdpw will try to load the configuration file from these locations:
$XDG_CONFIG_HOME defaults to ~/.config. $XDG_CURRENT_DESKTOP can be a colon separated list. Each element of that list will be tried.
The configuration files use the INI file format. Example:
[screencast] output_name=HDMI-A-1 max_fps=30 exec_before=disable_notifications.sh exec_after=enable_notifications.sh chooser_type=simple chooser_cmd=slurp -f %o -or
These options need to be placed under the [screencast] section.
output_name = name
This option is used with chooser_type = none. The list of available outputs can be obtained via wayland-info(1) (under the zxdg_output_manager_v1 section).
max_fps = limit
This is useful to reduce CPU usage when capturing frames at the output's refresh rate is unnecessary.
exec_before = command
exec_after = command
chooser_cmd = command
For more details see OUTPUT CHOOSER.
chooser_type = type
The supported types are:
force_mod_linear = bool
Setting this option to 1 will force xdpw to allocate dma-bufs with implicit modifier as linear. This option shouldn't be required on single gpu setups, but can increase compatibility especially on setups with multiple gpus.
This option is experimental and can be removed or replaced in future versions.
The chooser can be any program or script with the following behaviour:
Supported types of choosers via the chooser_type option: