Merge pull request #21353 from ramezgerges/skpicture_collapsing_invalidation_include_self

fix(visual): InvalidateParentChildrenPicture does not invalidate self even when includeSelf is true

Author: ramezgerges

src/Uno.UI.Composition/Composition/Visual.skia.cs

@@ -7,6 +7,7 @@
 using System.Diagnostics;
 using System.Numerics;
 using System.Runtime.CompilerServices;
+using System.Text;
 using Microsoft.CodeAnalysis.PooledObjects;
 using SkiaSharp;
 using Uno.Disposables;
@@ -212,7 +213,7 @@ internal void InvalidatePaint()
 
 	internal void InvalidateParentChildrenPicture(bool includeSelf)
 	{
-		var parent = includeSelf ? Parent : this;
+		var parent = includeSelf ? this : Parent;
 		while (parent is not null && (parent._flags & VisualFlags.ChildrenSKPictureInvalid) == 0)
 		{
 			parent._childrenPicture?.Dispose();
@@ -614,6 +615,30 @@ private unsafe void CreateLocalSession(in PaintingSession parentSession, out Pai
 #endif
 	}
 
+	internal void PrintSubtree(StringBuilder sb, int indent = 0)
+	{
+		var indentation = new string(' ', indent * 2);
+		sb.Append(indentation);
+		sb.Append('[');
+		sb.Append(Comment);
+		sb.Append("]: ");
+		sb.Append("Subtree count: [");
+		sb.Append(GetSubTreeVisualCount());
+		sb.Append("], flags: [");
+		sb.Append(_flags);
+		sb.Append("], _totalMatrix: [");
+		sb.Append(_totalMatrix.matrix);
+		sb.Append(']');
+		sb.Append("], _framesSinceSubtreeNotChanged: [");
+		sb.Append(_framesSinceSubtreeNotChanged);
+		sb.Append(']');
+		sb.AppendLine();
+		foreach (var child in GetChildrenInRenderOrder())
+		{
+			child.PrintSubtree(sb, indent + 1);
+		}
+	}
+
 	[Flags]
 	internal enum VisualFlags : byte
 	{

src/Uno.UI.RuntimeTests/Tests/Windows_UI_Composition/Given_ContainerVisual.cs

@@ -1,21 +1,28 @@
-using System;
-using System.Collections.Generic;
+#if __SKIA__
 using System.Linq;
 using System.Numerics;
-using System.Text;
 using System.Threading.Tasks;
+using Windows.Foundation;
 using Windows.UI;
-using Private.Infrastructure;
-using Microsoft.UI.Composition;
+using Microsoft.UI.Xaml;
 using Microsoft.UI.Xaml.Controls;
+using Private.Infrastructure;
+using Microsoft.UI.Xaml.Controls.Primitives;
 using Microsoft.UI.Xaml.Media;
 using Microsoft.UI.Xaml.Shapes;
+using SamplesApp.UITests;
+using SkiaSharp;
+using Uno.Disposables;
+using Uno.Extensions.Specialized;
 using Uno.UI.RuntimeTests.Helpers;
+using Uno.WinUI.Graphics2DSK;
+using CollectionExtensions = Uno.Extensions.CollectionExtensions;
+using RectExtensions = Uno.Extensions.RectExtensions;
 
 namespace Uno.UI.RuntimeTests.Tests.Windows_UI_Composition;
 
-#if __SKIA__
 [TestClass]
+[RunsOnUIThread]
 public class Given_ContainerVisual
 {
 	[TestMethod]
@@ -47,7 +54,6 @@ public void When_Children_Change()
 	}
 
 	[TestMethod]
-	[RunsOnUIThread]
 	public async Task When_Child_Removed_TotalMatrix_Updated()
 	{
 		var compositor = TestServices.WindowHelper.XamlRoot.Compositor;
@@ -63,5 +69,69 @@ public async Task When_Child_Removed_TotalMatrix_Updated()
 		parent2.Children.InsertAtTop(child);
 		Assert.IsFalse(child.TotalMatrix.IsIdentity);
 	}
+
+	[TestMethod]
+	public async Task When_SKPicture_Collapsing_Optimization()
+	{
+		var oldValues =
+			(FeatureConfiguration.Rendering.EnableVisualSubtreeSkippingOptimization,
+				FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationCleanFramesThreshold,
+				FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationVisualCountThreshold);
+		using var _ = Disposable.Create(() =>
+		{
+			(FeatureConfiguration.Rendering.EnableVisualSubtreeSkippingOptimization,
+				FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationCleanFramesThreshold,
+				FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationVisualCountThreshold) = oldValues;
+		});
+		(FeatureConfiguration.Rendering.EnableVisualSubtreeSkippingOptimization,
+			FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationCleanFramesThreshold,
+			FeatureConfiguration.Rendering.VisualSubtreeSkippingOptimizationVisualCountThreshold) = (true, 50, 100);
+		var popup = new Popup()
+		{
+			Child = new StackPanel().Apply(sp => Enumerable.Range(0, 100).ForEach(i =>
+				sp.Children.Add(new Rectangle
+				{
+					Fill = new SolidColorBrush(Colors.Red),
+					Width = 100,
+					Height = 100
+				})))
+		};
+
+		var skce = new FrameCounterSKCanvasElement() { Width = 100, Height = 100 };
+		popup.PlacementTarget = skce;
+		popup.DesiredPlacement = PopupPlacementMode.Bottom;
+		await UITestHelper.Load(new StackPanel { Children = { skce, popup } });
+
+		for (int i = 0; i < 200; i++)
+		{
+			popup.IsOpen = !popup.IsOpen;
+			await UITestHelper.WaitForIdle();
+			var count = skce.FrameCounter;
+			await UITestHelper.WaitFor(() => skce.FrameCounter > count);
+		}
+
+		popup.IsOpen = true;
+		await UITestHelper.WaitForIdle();
+		var p = (popup.Child as FrameworkElement).GetAbsoluteBoundsRect().GetLocation().Offset(50, 50);
+
+		var screenShot1 = await UITestHelper.ScreenShot(((FrameworkElement)TestServices.WindowHelper.XamlRoot.VisualTree.RootElement)!);
+		ImageAssert.HasColorAt(screenShot1, p, Colors.Red);
+
+		popup.IsOpen = false;
+		await UITestHelper.WaitForIdle();
+
+		var screenShot2 = await UITestHelper.ScreenShot(((FrameworkElement)TestServices.WindowHelper.XamlRoot.VisualTree.RootElement)!);
+		ImageAssert.DoesNotHaveColorAt(screenShot2, p, Colors.Red);
+	}
+
+	private class FrameCounterSKCanvasElement : SKCanvasElement
+	{
+		public int FrameCounter { get; private set; }
+		protected override void RenderOverride(SKCanvas canvas, Size area)
+		{
+			FrameCounter++;
+			Invalidate();
+		}
+	}
 }
 #endif