From 56ebfde540da9631548773baba87beb716660322 Mon Sep 17 00:00:00 2001 From: Alexander Orzechowski Date: Sat, 11 May 2024 11:59:36 -0400 Subject: [PATCH] docs: Add notes about WLR_SCENE_DISABLE_VISIBILITY effectively disabling direct scanout. --- docs/env_vars.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/env_vars.md b/docs/env_vars.md index 263eb8945..a2a86c84d 100644 --- a/docs/env_vars.md +++ b/docs/env_vars.md @@ -57,7 +57,9 @@ wlroots reads these environment variables * *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 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 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