output-layer: document interactions with screen capture

When e.g. screencopy-v1 is active, callers are responsible for
disabling output layers.
This commit is contained in:
Simon Ser 2023-02-21 11:15:05 +01:00 committed by Isaac Freund
parent bea6bee55d
commit 3874577d3c

View file

@ -32,6 +32,10 @@
* directly are expected to setup layers, call wlr_output_test(), paint the * directly are expected to setup layers, call wlr_output_test(), paint the
* layers that the backend rejected with the renderer, then call * layers that the backend rejected with the renderer, then call
* wlr_output_commit(). * 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 wlr_output_layer {
struct wl_list link; // wlr_output.layers struct wl_list link; // wlr_output.layers