WindowServer: Fix some gliches when overlays are moved or removed

Keep track of areas that overlays were rendered to when we recompute
occlusions. This allows us to then easily figure out areas where
overlays were moved from or removed from.

4 files changed, 35 insertions, 19 deletions

diff --git a/Userland/Services/WindowServer/Compositor.cpp b/Userland/Services/WindowServer/Compositor.cpp
index 7218942e3f..7316d0fcc8 100644
--- a/Userland/Services/WindowServer/Compositor.cpp
+++ b/Userland/Services/WindowServer/Compositor.cpp
@@ -1000,19 +1000,23 @@ void Compositor::add_overlay(Overlay& overlay)
     if (!did_insert)
         m_overlay_list.append(overlay);
 
-    overlay.clear_invalidated();
+    overlay.invalidate();
     overlay_rects_changed();
-    auto& rect = overlay.rect();
-    if (!rect.is_empty())
-        invalidate_screen(rect);
 }
 
 void Compositor::remove_overlay(Overlay& overlay)
 {
-    auto& current_render_rect = overlay.current_render_rect();
-    if (!current_render_rect.is_empty())
-        invalidate_screen(current_render_rect);
     m_overlay_list.remove(overlay);
+
+    auto last_rendered_rect = overlay.current_render_rect();
+    if (!last_rendered_rect.is_empty()) {
+        // We need to invalidate the entire area. While recomputing occlusions
+        // will detect areas no longer occupied by overlays, if there are other
+        // overlays intersecting with the overlay that was removed, then that
+        // area would not get re-rendered.
+        invalidate_screen(last_rendered_rect);
+    }
+
     overlay_rects_changed();
 }
 
@@ -1133,8 +1137,6 @@ void Compositor::overlay_rects_changed()
     m_overlay_rects_changed = true;
     m_invalidated_any = true;
     invalidate_occlusions();
-    for (auto& rect : m_overlay_rects.rects())
-        invalidate_screen(rect);
     start_compose_async_timer();
 }
 
@@ -1144,13 +1146,19 @@ void Compositor::recompute_overlay_rects()
     // regular window contents. This effectively just forces those areas to
     // be rendered as transparency areas, which allows us to render these
     // flicker-free.
+    swap(m_last_rendered_overlay_rects, m_overlay_rects);
     m_overlay_rects.clear_with_capacity();
     for (auto& overlay : m_overlay_list) {
         auto& render_rect = overlay.rect();
         m_overlay_rects.add(render_rect);
 
+        // Invalidate areas that are no longer in the rendered area because the overlay was moved.
+        auto previous_rects = overlay.current_render_rect().shatter(render_rect);
+        for (auto& rect : previous_rects)
+            invalidate_screen(rect);
+
         // Save the rectangle we are using for rendering from now on
-        overlay.did_recompute_occlusions();
+        bool needs_invalidation = overlay.apply_render_rect();
 
         // Cache which screens this overlay are rendered on
         overlay.m_screens.clear_with_capacity();
@@ -1160,8 +1168,15 @@ void Compositor::recompute_overlay_rects()
             return IterationDecision::Continue;
         });
 
-        invalidate_screen(render_rect);
+        if (needs_invalidation)
+            invalidate_screen(render_rect);
     }
+
+    // Invalidate rects that are not going to get rendered anymore, e.g.
+    // because overlays were removed or rectangles were changed
+    auto no_longer_rendered_rects = m_last_rendered_overlay_rects.shatter(m_overlay_rects);
+    for (auto& rect : no_longer_rendered_rects.rects())
+        invalidate_screen(rect);
 }
 
 void Compositor::recompute_occlusions()
diff --git a/Userland/Services/WindowServer/Compositor.h b/Userland/Services/WindowServer/Compositor.h
index c05bc39997..cb3ba983b0 100644
--- a/Userland/Services/WindowServer/Compositor.h
+++ b/Userland/Services/WindowServer/Compositor.h
@@ -226,6 +226,7 @@ private:
 
     IntrusiveList<&Overlay::m_list_node> m_overlay_list;
     Gfx::DisjointIntRectSet m_overlay_rects;
+    Gfx::DisjointIntRectSet m_last_rendered_overlay_rects;
     Gfx::DisjointIntRectSet m_dirty_screen_rects;
     Gfx::DisjointIntRectSet m_opaque_wallpaper_rects;
     Gfx::DisjointIntRectSet m_transparent_wallpaper_rects;
diff --git a/Userland/Services/WindowServer/Overlays.cpp b/Userland/Services/WindowServer/Overlays.cpp
index 34106bd890..db3ab5dded 100644
--- a/Userland/Services/WindowServer/Overlays.cpp
+++ b/Userland/Services/WindowServer/Overlays.cpp
@@ -13,7 +13,8 @@ namespace WindowServer {
 
 Overlay::~Overlay()
 {
-    Compositor::the().remove_overlay(*this);
+    if (is_enabled())
+        Compositor::the().remove_overlay(*this);
 }
 
 bool Overlay::invalidate()
@@ -21,9 +22,8 @@ bool Overlay::invalidate()
     if (m_invalidated)
         return false;
     m_invalidated = true;
-    // m_current_rect should only get updated by recompute_overlay_rects()
-    if (!m_current_rect.is_empty())
-        Compositor::the().invalidate_screen(m_current_rect);
+    if (is_enabled())
+        Compositor::the().overlay_rects_changed();
     return true;
 }
 
@@ -45,8 +45,6 @@ void Overlay::set_rect(Gfx::IntRect const& rect)
     auto previous_rect = m_rect;
     m_rect = rect;
     invalidate();
-    if (is_enabled())
-        Compositor::the().overlay_rects_changed();
     rect_changed(previous_rect);
 }
 
@@ -257,6 +255,7 @@ void WindowGeometryOverlay::update_rect()
             rect.set_bottom_without_resize(desktop_rect.bottom());
 
         set_rect(rect);
+        invalidate_content(); // needed in case the rectangle itself doesn't change. But the contents did.
     } else {
         set_enabled(false);
     }
diff --git a/Userland/Services/WindowServer/Overlays.h b/Userland/Services/WindowServer/Overlays.h
index 9bbb8df6f2..ddf6aceeeb 100644
--- a/Userland/Services/WindowServer/Overlays.h
+++ b/Userland/Services/WindowServer/Overlays.h
@@ -56,11 +56,12 @@ protected:
     virtual void rect_changed(Gfx::IntRect const&) {};
 
 private:
-    void clear_invalidated() { m_invalidated = false; }
-    void did_recompute_occlusions()
+    [[nodiscard]] bool apply_render_rect()
     {
+        bool needs_invalidation = m_invalidated;
         m_invalidated = false;
         m_current_rect = m_rect;
+        return needs_invalidation;
     }
 
     Gfx::IntRect m_rect;