aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorSimon Ser <contact@emersion.fr>2023-02-21 11:15:05 +0100
committerIsaac Freund <mail@isaacfreund.com>2023-02-21 10:35:30 +0000
commit3874577d3c2a37c4291962103a18f13c8862da76 (patch)
tree99832a66ef68457eff8cda66cc2124fcb98e8a92 /include
parentbea6bee55d83398f1f3696c66fcaf3240751e4c5 (diff)
output-layer: document interactions with screen capture
When e.g. screencopy-v1 is active, callers are responsible for disabling output layers.
Diffstat (limited to 'include')
-rw-r--r--include/wlr/types/wlr_output_layer.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/include/wlr/types/wlr_output_layer.h b/include/wlr/types/wlr_output_layer.h
index 9f787e2c..bd10fd12 100644
--- a/include/wlr/types/wlr_output_layer.h
+++ b/include/wlr/types/wlr_output_layer.h
@@ -32,6 +32,10 @@
* directly are expected to setup layers, call wlr_output_test(), paint the
* layers that the backend rejected with the renderer, then call
* wlr_output_commit().
+ *
+ * Callers are responsible for disabling output layers when they need the full
+ * output contents to be composited onto a single buffer, e.g. during screen
+ * capture.
*/
struct wlr_output_layer {
struct wl_list link; // wlr_output.layers