docs: Add notes about WLR_SCENE_DISABLE_VISIBILITY effectively disabling direct scanout.

This commit is contained in:
Alexander Orzechowski 2024-05-11 11:59:36 -04:00
parent f0b7fb72a8
commit 56ebfde540

View File

@ -57,7 +57,9 @@ wlroots reads these environment variables
* *WLR_SCENE_DISABLE_DIRECT_SCANOUT*: disables direct scan-out for debugging. * *WLR_SCENE_DISABLE_DIRECT_SCANOUT*: disables direct scan-out for debugging.
* *WLR_SCENE_DISABLE_VISIBILITY*: If set to 1, the visibility of all scene nodes * *WLR_SCENE_DISABLE_VISIBILITY*: If set to 1, the visibility of all scene nodes
will be considered to be the full node. Intelligent visibility canculations will will be considered to be the full node. Intelligent visibility canculations will
be disabled. be disabled. Note that direct scanout will not work for most cases when this
option is set as surfaces that don't contribute to the rendered output will now
bail direct scanout (desktop background / black rect underneath).
* *WLR_SCENE_HIGHLIGHT_TRANSPARENT_REGION*: Highlights regions of scene buffers * *WLR_SCENE_HIGHLIGHT_TRANSPARENT_REGION*: Highlights regions of scene buffers
that are advertised as transparent through wlr_scene_buffer_set_opaque_region(). that are advertised as transparent through wlr_scene_buffer_set_opaque_region().
This can be used to debug issues with clients advertizing bogus opaque regions This can be used to debug issues with clients advertizing bogus opaque regions