Default to unrestricted primary plane scanout

1 files changed, 15 insertions, 0 deletions

diff --git a/wiki/Configuration:-Debug-Options.md b/wiki/Configuration:-Debug-Options.md
index 66b449ff..cdb0c7cc 100644
--- a/wiki/Configuration:-Debug-Options.md
+++ b/wiki/Configuration:-Debug-Options.md
@@ -16,6 +16,7 @@ debug {
     enable-overlay-planes
     disable-cursor-plane
     disable-direct-scanout
+    restrict-primary-scanout-to-matching-format
     render-drm-device "/dev/dri/renderD129"
     force-pipewire-invalid-modifier
     dbus-interfaces-in-non-session-instances
@@ -84,6 +85,20 @@ debug {
 }
 ```
 
+### `restrict-primary-scanout-to-matching-format`
+
+Restricts direct scanout to the primary plane to when the window buffer exactly matches the composition swapchain format.
+
+This flag may prevent unexpected bandwidth changes when going between composition and scanout.
+The plan is to make it default in the future, when we implement a way to tell the clients the composition swapchain format.
+As is, it may prevent some clients (mpv on my machine) from scanning out to the primary plane.
+
+```kdl
+debug {
+    restrict-primary-scanout-to-matching-format
+}
+```
+
 ### `render-drm-device`
 
 Override the DRM device that niri will use for all rendering.