From cf0688565a4c1044d5361380d4388ae883838bbd Mon Sep 17 00:00:00 2001 From: Dariusz Komosinski Date: Sun, 5 Jun 2022 17:34:34 +0200 Subject: [PATCH 01/20] Refactor value storage to reduce overhead and memory allocations. --- src/Avalonia.Base/Avalonia.Base.csproj | 1 + src/Avalonia.Base/AvaloniaObject.cs | 16 + src/Avalonia.Base/StyledElement.cs | 18 +- .../Utilities/AvaloniaPropertyValueStore.cs | 236 +++++++----- src/Avalonia.Base/ValueStore.cs | 12 +- .../Avalonia.Benchmarks.csproj | 3 + .../Base/ValueStoreAddRemoveBenchmarks.cs | 351 ++++++++++++++++++ .../Layout/ControlsBenchmark.cs | 33 ++ 8 files changed, 561 insertions(+), 109 deletions(-) create mode 100644 tests/Avalonia.Benchmarks/Base/ValueStoreAddRemoveBenchmarks.cs diff --git a/src/Avalonia.Base/Avalonia.Base.csproj b/src/Avalonia.Base/Avalonia.Base.csproj index 16a91b10d6..15f3b67643 100644 --- a/src/Avalonia.Base/Avalonia.Base.csproj +++ b/src/Avalonia.Base/Avalonia.Base.csproj @@ -20,6 +20,7 @@ + diff --git a/src/Avalonia.Base/AvaloniaObject.cs b/src/Avalonia.Base/AvaloniaObject.cs index 1f14ddede4..240ce80825 100644 --- a/src/Avalonia.Base/AvaloniaObject.cs +++ b/src/Avalonia.Base/AvaloniaObject.cs @@ -25,6 +25,7 @@ namespace Avalonia private List? _inheritanceChildren; private ValueStore? _values; private bool _batchUpdate; + private bool _isInitializing; /// /// Initializes a new instance of the class. @@ -126,6 +127,9 @@ namespace Avalonia { _values = new ValueStore(this); + _values.IsInitializing = _isInitializing; + _isInitializing = false; + if (_batchUpdate) _values.BeginBatchUpdate(); } @@ -493,6 +497,18 @@ namespace Avalonia _batchUpdate = false; _values?.EndBatchUpdate(); } + + internal void SetValueStoreIsInitializing(bool isInitializing) + { + if (_values is null) + { + _isInitializing = isInitializing; + + return; + } + + _values.IsInitializing = isInitializing; + } /// internal void AddInheritanceChild(AvaloniaObject child) diff --git a/src/Avalonia.Base/StyledElement.cs b/src/Avalonia.Base/StyledElement.cs index f98d2cdbcc..b19ef85cfa 100644 --- a/src/Avalonia.Base/StyledElement.cs +++ b/src/Avalonia.Base/StyledElement.cs @@ -306,6 +306,11 @@ namespace Avalonia public virtual void BeginInit() { ++_initCount; + + if (_initCount == 1) + { + SetValueStoreIsInitializing(true); + } } /// @@ -316,10 +321,15 @@ namespace Avalonia throw new InvalidOperationException("BeginInit was not called."); } - if (--_initCount == 0 && _logicalRoot != null) + if (--_initCount == 0) { - ApplyStyling(); - InitializeIfNeeded(); + if (_logicalRoot is not null) + { + ApplyStyling(); + InitializeIfNeeded(); + } + + SetValueStoreIsInitializing(false); } } @@ -337,11 +347,13 @@ namespace Avalonia try { BeginBatchUpdate(); + SetValueStoreIsInitializing(true); AvaloniaLocator.Current.GetService()?.ApplyStyles(this); } finally { EndBatchUpdate(); + SetValueStoreIsInitializing(false); } _styled = true; diff --git a/src/Avalonia.Base/Utilities/AvaloniaPropertyValueStore.cs b/src/Avalonia.Base/Utilities/AvaloniaPropertyValueStore.cs index cbe3771577..9dbe0765de 100644 --- a/src/Avalonia.Base/Utilities/AvaloniaPropertyValueStore.cs +++ b/src/Avalonia.Base/Utilities/AvaloniaPropertyValueStore.cs @@ -1,5 +1,4 @@ using System; -using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; namespace Avalonia.Utilities @@ -8,166 +7,197 @@ namespace Avalonia.Utilities /// Stores values with as key. /// /// Stored value type. - internal sealed class AvaloniaPropertyValueStore + internal struct AvaloniaPropertyValueStore { - // The last item in the list is always int.MaxValue. - private static readonly Entry[] s_emptyEntries = { new Entry { PropertyId = int.MaxValue, Value = default! } }; - - private Entry[] _entries; + private Entry[]? _entries; + private int _entryCount; public AvaloniaPropertyValueStore() { - _entries = s_emptyEntries; + _entries = null; + _entryCount = 0; + IsInitializing = false; + InitialSize = 4; } - public int Count => _entries.Length - 1; - public TValue this[int index] => _entries[index].Value; + public int Count => _entryCount; + + public bool IsInitializing { get; set; } + + public int InitialSize { get; set; } + + public TValue this[int index] => _entries![index].Value; - private (int, bool) TryFindEntry(int propertyId) + private EntryIndex LookupEntry(int propertyId) { - if (_entries.Length <= 12) + int checkIndex; + int iLo = 0; + int iHi = _entryCount; + + if (iHi <= 0) { - // For small lists, we use an optimized linear search. Since the last item in the list - // is always int.MaxValue, we can skip a conditional branch in each iteration. - // By unrolling the loop, we can skip another unconditional branch in each iteration. - - if (_entries[0].PropertyId >= propertyId) - return (0, _entries[0].PropertyId == propertyId); - if (_entries[1].PropertyId >= propertyId) - return (1, _entries[1].PropertyId == propertyId); - if (_entries[2].PropertyId >= propertyId) - return (2, _entries[2].PropertyId == propertyId); - if (_entries[3].PropertyId >= propertyId) - return (3, _entries[3].PropertyId == propertyId); - if (_entries[4].PropertyId >= propertyId) - return (4, _entries[4].PropertyId == propertyId); - if (_entries[5].PropertyId >= propertyId) - return (5, _entries[5].PropertyId == propertyId); - if (_entries[6].PropertyId >= propertyId) - return (6, _entries[6].PropertyId == propertyId); - if (_entries[7].PropertyId >= propertyId) - return (7, _entries[7].PropertyId == propertyId); - if (_entries[8].PropertyId >= propertyId) - return (8, _entries[8].PropertyId == propertyId); - if (_entries[9].PropertyId >= propertyId) - return (9, _entries[9].PropertyId == propertyId); - if (_entries[10].PropertyId >= propertyId) - return (10, _entries[10].PropertyId == propertyId); + return new EntryIndex(0, found: false); } - else + + // Do a binary search to find the value + while (iHi - iLo > 3) { - int low = 0; - int high = _entries.Length; - int id; + int iPv = (iHi + iLo) / 2; + checkIndex = _entries![iPv].PropertyId; - while (high - low > 3) + if (propertyId == checkIndex) { - int pivot = (high + low) / 2; - id = _entries[pivot].PropertyId; - - if (propertyId == id) - return (pivot, true); - - if (propertyId <= id) - high = pivot; - else - low = pivot + 1; + return new EntryIndex(iPv, found: true); } - do + if (propertyId <= checkIndex) + { + iHi = iPv; + } + else { - id = _entries[low].PropertyId; + iLo = iPv + 1; + } + } - if (id == propertyId) - return (low, true); + // Now we only have three values to search; switch to a linear search + do + { + checkIndex = _entries![iLo].PropertyId; - if (id > propertyId) - break; + if (checkIndex == propertyId) + { + return new EntryIndex(iLo, found: true); + } - ++low; + if (checkIndex > propertyId) + { + // we've gone past the targetIndex - return not found + break; } - while (low < high); - } - return (0, false); + iLo++; + } while (iLo < iHi); + + return new EntryIndex(iLo, found: false); } public bool TryGetValue(AvaloniaProperty property, [MaybeNullWhen(false)] out TValue value) { - (int index, bool found) = TryFindEntry(property.Id); - if (!found) + var entryIndex = LookupEntry(property.Id); + + if (!entryIndex.Found) { value = default; return false; } - value = _entries[index].Value; + value = _entries![entryIndex.Index].Value; + return true; } - public void AddValue(AvaloniaProperty property, TValue value) + private void InsertEntry(Entry entry, int entryIndex) { - Entry[] entries = new Entry[_entries.Length + 1]; - - for (int i = 0; i < _entries.Length; ++i) + if (_entryCount > 0) { - if (_entries[i].PropertyId > property.Id) + if (_entryCount == _entries!.Length) { - if (i > 0) + // We want to have more aggressive resizing when initializing. + var growthFactor = IsInitializing ? 2.0 : 1.2; + + var newSize = (int)(_entryCount * growthFactor); + + if (newSize == _entryCount) { - Array.Copy(_entries, 0, entries, 0, i); + newSize++; } - entries[i] = new Entry { PropertyId = property.Id, Value = value }; - Array.Copy(_entries, i, entries, i + 1, _entries.Length - i); - break; + var destEntries = new Entry[newSize]; + + Array.Copy(_entries, 0, destEntries, 0, entryIndex); + + destEntries[entryIndex] = entry; + + Array.Copy(_entries, entryIndex, destEntries, entryIndex + 1, _entryCount - entryIndex); + + _entries = destEntries; } + else + { + Array.Copy( + _entries, + entryIndex, + _entries, + entryIndex + 1, + _entryCount - entryIndex); + + _entries[entryIndex] = entry; + } + } + else + { + if (_entries is null) + { + _entries = new Entry[InitialSize]; + } + + _entries[0] = entry; } - _entries = entries; + _entryCount++; + } + + public void AddValue(AvaloniaProperty property, TValue value) + { + var propertyId = property.Id; + var index = LookupEntry(propertyId); + + InsertEntry(new Entry(propertyId, value), index.Index); } public void SetValue(AvaloniaProperty property, TValue value) { - _entries[TryFindEntry(property.Id).Item1].Value = value; + var propertyId = property.Id; + var entryIndex = LookupEntry(propertyId); + + _entries![entryIndex.Index] = new Entry(propertyId, value); } public void Remove(AvaloniaProperty property) { - var (index, found) = TryFindEntry(property.Id); + var entry = LookupEntry(property.Id); - if (found) - { - var newLength = _entries.Length - 1; - - // Special case - one element left means that value store is empty so we can just reuse our "empty" array. - if (newLength == 1) - { - _entries = s_emptyEntries; - - return; - } - - var entries = new Entry[newLength]; + if (!entry.Found) return; + + Array.Copy(_entries!, entry.Index + 1, _entries!, entry.Index, _entryCount - entry.Index - 1); - int ix = 0; + _entryCount--; + _entries![_entryCount] = default; + } - for (int i = 0; i < _entries.Length; ++i) - { - if (i != index) - { - entries[ix++] = _entries[i]; - } - } + private readonly struct EntryIndex + { + public readonly int Index; + public readonly bool Found; - _entries = entries; + public EntryIndex(int index, bool found) + { + Index = index; + Found = found; } } - private struct Entry + private readonly struct Entry { - internal int PropertyId; - internal TValue Value; + public readonly int PropertyId; + public readonly TValue Value; + + public Entry(int propertyId, TValue value) + { + PropertyId = propertyId; + Value = value; + } } } } diff --git a/src/Avalonia.Base/ValueStore.cs b/src/Avalonia.Base/ValueStore.cs index 69c644dff9..664fe6c820 100644 --- a/src/Avalonia.Base/ValueStore.cs +++ b/src/Avalonia.Base/ValueStore.cs @@ -24,7 +24,7 @@ namespace Avalonia internal class ValueStore { private readonly AvaloniaObject _owner; - private readonly AvaloniaPropertyValueStore _values; + private AvaloniaPropertyValueStore _values; private BatchUpdate? _batchUpdate; public ValueStore(AvaloniaObject owner) @@ -33,6 +33,12 @@ namespace Avalonia _values = new AvaloniaPropertyValueStore(); } + public bool IsInitializing + { + get => _values.IsInitializing; + set => _values.IsInitializing = value; + } + public void BeginBatchUpdate() { _batchUpdate ??= new BatchUpdate(this); @@ -381,7 +387,7 @@ namespace Avalonia private class BatchUpdate { - private ValueStore _owner; + private readonly ValueStore _owner; private List? _notifications; private int _batchUpdateCount; private int _iterator = -1; @@ -408,7 +414,7 @@ namespace Avalonia if (--_batchUpdateCount > 0) return false; - var values = _owner._values; + ref var values = ref _owner._values; // First call EndBatchUpdate on all bindings. This should cause the active binding to be subscribed // but notifications will still not be raised because the owner ValueStore will still have a reference diff --git a/tests/Avalonia.Benchmarks/Avalonia.Benchmarks.csproj b/tests/Avalonia.Benchmarks/Avalonia.Benchmarks.csproj index 5d17808e0c..7afc0c569f 100644 --- a/tests/Avalonia.Benchmarks/Avalonia.Benchmarks.csproj +++ b/tests/Avalonia.Benchmarks/Avalonia.Benchmarks.csproj @@ -5,6 +5,9 @@ Exe false + + + diff --git a/tests/Avalonia.Benchmarks/Base/ValueStoreAddRemoveBenchmarks.cs b/tests/Avalonia.Benchmarks/Base/ValueStoreAddRemoveBenchmarks.cs new file mode 100644 index 0000000000..9397ea79b4 --- /dev/null +++ b/tests/Avalonia.Benchmarks/Base/ValueStoreAddRemoveBenchmarks.cs @@ -0,0 +1,351 @@ +using System; +using System.Diagnostics.CodeAnalysis; +using Avalonia.Utilities; +using BenchmarkDotNet.Attributes; + +namespace Avalonia.Benchmarks.Base; + +// TODO: Remove after review together with related benchmark code. +internal sealed class AvaloniaPropertyValueStoreOld +{ + // The last item in the list is always int.MaxValue. + private static readonly Entry[] s_emptyEntries = { new Entry { PropertyId = int.MaxValue, Value = default! } }; + + private Entry[] _entries; + + public AvaloniaPropertyValueStoreOld() + { + _entries = s_emptyEntries; + } + + public int Count => _entries.Length - 1; + public TValue this[int index] => _entries[index].Value; + + private (int, bool) TryFindEntry(int propertyId) + { + if (_entries.Length <= 12) + { + // For small lists, we use an optimized linear search. Since the last item in the list + // is always int.MaxValue, we can skip a conditional branch in each iteration. + // By unrolling the loop, we can skip another unconditional branch in each iteration. + + if (_entries[0].PropertyId >= propertyId) + return (0, _entries[0].PropertyId == propertyId); + if (_entries[1].PropertyId >= propertyId) + return (1, _entries[1].PropertyId == propertyId); + if (_entries[2].PropertyId >= propertyId) + return (2, _entries[2].PropertyId == propertyId); + if (_entries[3].PropertyId >= propertyId) + return (3, _entries[3].PropertyId == propertyId); + if (_entries[4].PropertyId >= propertyId) + return (4, _entries[4].PropertyId == propertyId); + if (_entries[5].PropertyId >= propertyId) + return (5, _entries[5].PropertyId == propertyId); + if (_entries[6].PropertyId >= propertyId) + return (6, _entries[6].PropertyId == propertyId); + if (_entries[7].PropertyId >= propertyId) + return (7, _entries[7].PropertyId == propertyId); + if (_entries[8].PropertyId >= propertyId) + return (8, _entries[8].PropertyId == propertyId); + if (_entries[9].PropertyId >= propertyId) + return (9, _entries[9].PropertyId == propertyId); + if (_entries[10].PropertyId >= propertyId) + return (10, _entries[10].PropertyId == propertyId); + } + else + { + int low = 0; + int high = _entries.Length; + int id; + + while (high - low > 3) + { + int pivot = (high + low) / 2; + id = _entries[pivot].PropertyId; + + if (propertyId == id) + return (pivot, true); + + if (propertyId <= id) + high = pivot; + else + low = pivot + 1; + } + + do + { + id = _entries[low].PropertyId; + + if (id == propertyId) + return (low, true); + + if (id > propertyId) + break; + + ++low; + } + while (low < high); + } + + return (0, false); + } + + public bool TryGetValue(AvaloniaProperty property, [MaybeNullWhen(false)] out TValue value) + { + (int index, bool found) = TryFindEntry(property.Id); + if (!found) + { + value = default; + return false; + } + + value = _entries[index].Value; + return true; + } + + public void AddValue(AvaloniaProperty property, TValue value) + { + Entry[] entries = new Entry[_entries.Length + 1]; + + for (int i = 0; i < _entries.Length; ++i) + { + if (_entries[i].PropertyId > property.Id) + { + if (i > 0) + { + Array.Copy(_entries, 0, entries, 0, i); + } + + entries[i] = new Entry { PropertyId = property.Id, Value = value }; + Array.Copy(_entries, i, entries, i + 1, _entries.Length - i); + break; + } + } + + _entries = entries; + } + + public void SetValue(AvaloniaProperty property, TValue value) + { + _entries[TryFindEntry(property.Id).Item1].Value = value; + } + + public void Remove(AvaloniaProperty property) + { + var (index, found) = TryFindEntry(property.Id); + + if (found) + { + var newLength = _entries.Length - 1; + + // Special case - one element left means that value store is empty so we can just reuse our "empty" array. + if (newLength == 1) + { + _entries = s_emptyEntries; + + return; + } + + var entries = new Entry[newLength]; + + int ix = 0; + + for (int i = 0; i < _entries.Length; ++i) + { + if (i != index) + { + entries[ix++] = _entries[i]; + } + } + + _entries = entries; + } + } + + private struct Entry + { + internal int PropertyId; + internal TValue Value; + } +} + +internal class MockProperty : StyledProperty +{ + public MockProperty([JetBrains.Annotations.NotNull] string name) : base(name, typeof(object), new StyledPropertyMetadata()) + { + } +} + +internal static class MockProperties +{ + public static readonly AvaloniaProperty[] LinearProperties; + public static readonly AvaloniaProperty[] ShuffledProperties; + + static MockProperties() + { + LinearProperties = new AvaloniaProperty[32]; + ShuffledProperties = new AvaloniaProperty[32]; + + for (int i = 0; i < LinearProperties.Length; i++) + { + LinearProperties[i] = ShuffledProperties[i] = new MockProperty($"Property#{i}"); + } + + Shuffle(ShuffledProperties, 42); + } + + private static void Shuffle (T[] array, int seed) + { + var rng = new Random(seed); + + int n = array.Length; + while (n > 1) + { + int k = rng.Next(n--); + T temp = array[n]; + array[n] = array[k]; + array[k] = temp; + } + } +} + +[MemoryDiagnoser] +public class ValueStoreLookupBenchmarks +{ + [Params(2, 6, 10, 20, 30)] + public int PropertyCount; + + [Params(false, true)] + public bool UseShuffledProperties; + + public AvaloniaProperty[] Properties => UseShuffledProperties ? MockProperties.ShuffledProperties : MockProperties.LinearProperties; + + private AvaloniaPropertyValueStore _store; + private AvaloniaPropertyValueStoreOld _oldStore; + + [GlobalSetup] + public void GlobalSetup() + { + _store = new AvaloniaPropertyValueStore(); + _oldStore = new AvaloniaPropertyValueStoreOld(); + + for (int i = 0; i < PropertyCount; i++) + { + _store.AddValue(Properties[i], null); + _oldStore.AddValue(Properties[i], null); + } + } + + [Benchmark] + public void LookupProperties() + { + for (int i = 0; i < PropertyCount; i++) + { + _store.TryGetValue(Properties[i], out _); + } + } + + [Benchmark] public void LookupProperties_Old() + { + for (int i = 0; i < PropertyCount; i++) + { + _oldStore.TryGetValue(Properties[i], out _); + } + } +} + +[MemoryDiagnoser] +public class ValueStoreAddRemoveBenchmarks +{ + [Params(2, 6, 10, 20, 30)] + public int PropertyCount; + + [Params(false, true)] + public bool UseShuffledProperties; + + public AvaloniaProperty[] Properties => UseShuffledProperties ? MockProperties.ShuffledProperties : MockProperties.LinearProperties; + + [Benchmark] + [Arguments(false)] + [Arguments(true)] + public void AddValue(bool isInitializing) + { + var store = new AvaloniaPropertyValueStore { IsInitializing = isInitializing }; + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + } + } + + [Benchmark] + [Arguments(false)] + [Arguments(true)] + public void AddAndRemoveValue(bool isInitializing) + { + var store = new AvaloniaPropertyValueStore { IsInitializing = isInitializing }; + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + } + + for (int i = PropertyCount - 1; i >= 0; i--) + { + store.Remove(Properties[i]); + } + } + + [Benchmark] + [Arguments(false)] + [Arguments(true)] + public void AddAndRemoveValueInterleaved(bool isInitializing) + { + var store = new AvaloniaPropertyValueStore { IsInitializing = isInitializing }; + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + store.Remove(Properties[i]); + } + } + + [Benchmark] + public void AddValue_Old() + { + var store = new AvaloniaPropertyValueStoreOld(); + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + } + } + + [Benchmark] + public void AddAndRemoveValue_Old() + { + var store = new AvaloniaPropertyValueStoreOld(); + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + } + + for (int i = PropertyCount - 1; i >= 0; i--) + { + store.Remove(Properties[i]); + } + } + + [Benchmark] + public void AddAndRemoveValueInterleaved_Old() + { + var store = new AvaloniaPropertyValueStoreOld(); + + for (int i = 0; i < PropertyCount; i++) + { + store.AddValue(Properties[i], null); + store.Remove(Properties[i]); + } + } +} diff --git a/tests/Avalonia.Benchmarks/Layout/ControlsBenchmark.cs b/tests/Avalonia.Benchmarks/Layout/ControlsBenchmark.cs index 3493dd0f53..e71330f8bd 100644 --- a/tests/Avalonia.Benchmarks/Layout/ControlsBenchmark.cs +++ b/tests/Avalonia.Benchmarks/Layout/ControlsBenchmark.cs @@ -39,6 +39,39 @@ namespace Avalonia.Benchmarks.Layout _root.LayoutManager.ExecuteLayoutPass(); } + [Benchmark] + [MethodImpl(MethodImplOptions.NoInlining)] + public void CreateControl() + { + var control = new Control(); + + _root.Child = control; + + _root.LayoutManager.ExecuteLayoutPass(); + } + + [Benchmark] + [MethodImpl(MethodImplOptions.NoInlining)] + public void CreateDecorator() + { + var control = new Decorator(); + + _root.Child = control; + + _root.LayoutManager.ExecuteLayoutPass(); + } + + [Benchmark] + [MethodImpl(MethodImplOptions.NoInlining)] + public void CreateScrollViewer() + { + var control = new ScrollViewer(); + + _root.Child = control; + + _root.LayoutManager.ExecuteLayoutPass(); + } + [Benchmark] [MethodImpl(MethodImplOptions.NoInlining)] public void CreateButton() From 4b7feeb4f4905bce85ba0787d9cd60b6063b3a98 Mon Sep 17 00:00:00 2001 From: Nikita Tsukanov Date: Mon, 18 Jul 2022 13:55:53 +0300 Subject: [PATCH 02/20] Fixed various invalidation and hit-testing issues --- .../Composition/CompositingRenderer.cs | 34 +- .../Composition/CompositionDrawListVisual.cs | 13 +- .../Composition/CompositionTarget.cs | 44 +- .../ICompositionTargetDebugEvents.cs | 6 + .../Server/ServerCompositionTarget.cs | 3 +- .../Server/ServerCompositionVisual.cs | 35 +- .../Transport/BatchStreamArrayPool.cs | 10 +- .../Rendering/Composition/Visual.cs | 2 +- .../Rendering/CompositorHitTestingTests.cs | 417 ++++++++++++++++++ .../Rendering/CompositorInvalidationTests.cs | 109 +++++ .../Rendering/CompositorTestsBase.cs | 208 +++++++++ .../MockPlatformRenderInterface.cs | 27 +- 12 files changed, 834 insertions(+), 74 deletions(-) create mode 100644 src/Avalonia.Base/Rendering/Composition/ICompositionTargetDebugEvents.cs create mode 100644 tests/Avalonia.Base.UnitTests/Rendering/CompositorHitTestingTests.cs create mode 100644 tests/Avalonia.Base.UnitTests/Rendering/CompositorInvalidationTests.cs create mode 100644 tests/Avalonia.Base.UnitTests/Rendering/CompositorTestsBase.cs diff --git a/src/Avalonia.Base/Rendering/Composition/CompositingRenderer.cs b/src/Avalonia.Base/Rendering/Composition/CompositingRenderer.cs index 282973c26a..a571a0518b 100644 --- a/src/Avalonia.Base/Rendering/Composition/CompositingRenderer.cs +++ b/src/Avalonia.Base/Rendering/Composition/CompositingRenderer.cs @@ -24,11 +24,12 @@ public class CompositingRenderer : IRendererWithCompositor DrawingContext _recordingContext; private HashSet _dirty = new(); private HashSet _recalculateChildren = new(); - private readonly CompositionTarget _target; private bool _queuedUpdate; private Action _update; private Action _invalidateScene; + internal CompositionTarget CompositionTarget; + /// /// Asks the renderer to only draw frames on the render thread. Makes Paint to wait until frame is rendered. /// @@ -40,8 +41,8 @@ public class CompositingRenderer : IRendererWithCompositor _root = root; _compositor = compositor; _recordingContext = new DrawingContext(_recorder); - _target = compositor.CreateCompositionTarget(root.CreateRenderTarget); - _target.Root = ((Visual)root!.VisualRoot!).AttachToCompositor(compositor); + CompositionTarget = compositor.CreateCompositionTarget(root.CreateRenderTarget); + CompositionTarget.Root = ((Visual)root!.VisualRoot!).AttachToCompositor(compositor); _update = Update; _invalidateScene = InvalidateScene; } @@ -49,15 +50,15 @@ public class CompositingRenderer : IRendererWithCompositor /// public bool DrawFps { - get => _target.DrawFps; - set => _target.DrawFps = value; + get => CompositionTarget.DrawFps; + set => CompositionTarget.DrawFps = value; } /// public bool DrawDirtyRects { - get => _target.DrawDirtyRects; - set => _target.DrawDirtyRects = value; + get => CompositionTarget.DrawDirtyRects; + set => CompositionTarget.DrawDirtyRects = value; } /// @@ -81,12 +82,11 @@ public class CompositingRenderer : IRendererWithCompositor /// public IEnumerable HitTest(Point p, IVisual root, Func? filter) { - var res = _target.TryHitTest(p, filter); + var res = CompositionTarget.TryHitTest(p, filter); if(res == null) yield break; - for (var index = res.Count - 1; index >= 0; index--) + foreach(var v in res) { - var v = res[index]; if (v is CompositionDrawListVisual dv) { if (filter == null || filter(dv.Visual)) @@ -234,8 +234,8 @@ public class CompositingRenderer : IRendererWithCompositor SyncChildren(v); _dirty.Clear(); _recalculateChildren.Clear(); - _target.Size = _root.ClientSize; - _target.Scaling = _root.RenderScaling; + CompositionTarget.Size = _root.ClientSize; + CompositionTarget.Scaling = _root.RenderScaling; Compositor.InvokeOnNextCommit(_invalidateScene); } @@ -246,24 +246,24 @@ public class CompositingRenderer : IRendererWithCompositor public void Paint(Rect rect) { Update(); - _target.RequestRedraw(); + CompositionTarget.RequestRedraw(); if(RenderOnlyOnRenderThread && Compositor.Loop.RunsInBackground) Compositor.RequestCommitAsync().Wait(); else - _target.ImmediateUIThreadRender(); + CompositionTarget.ImmediateUIThreadRender(); } - public void Start() => _target.IsEnabled = true; + public void Start() => CompositionTarget.IsEnabled = true; public void Stop() { - _target.IsEnabled = false; + CompositionTarget.IsEnabled = false; } public void Dispose() { Stop(); - _target.Dispose(); + CompositionTarget.Dispose(); // Wait for the composition batch to be applied and rendered to guarantee that // render target is not used anymore and can be safely disposed diff --git a/src/Avalonia.Base/Rendering/Composition/CompositionDrawListVisual.cs b/src/Avalonia.Base/Rendering/Composition/CompositionDrawListVisual.cs index 47cfcd325b..49aea1c3dc 100644 --- a/src/Avalonia.Base/Rendering/Composition/CompositionDrawListVisual.cs +++ b/src/Avalonia.Base/Rendering/Composition/CompositionDrawListVisual.cs @@ -54,13 +54,20 @@ internal class CompositionDrawListVisual : CompositionContainerVisual internal override bool HitTest(Point pt, Func? filter) { - if (DrawList == null) + var custom = Visual as ICustomHitTest; + if (DrawList == null && custom == null) return false; if (filter != null && !filter(Visual)) return false; - if (Visual is ICustomHitTest custom) + if (custom != null) + { + // Simulate the old behavior + // TODO: Change behavior once legacy renderers are removed + pt += new Point(Offset.X, Offset.Y); return custom.HitTest(pt); - foreach (var op in DrawList) + } + + foreach (var op in DrawList!) if (op.Item.HitTest(pt)) return true; return false; diff --git a/src/Avalonia.Base/Rendering/Composition/CompositionTarget.cs b/src/Avalonia.Base/Rendering/Composition/CompositionTarget.cs index 25bbd4dc88..01b2d0d5d9 100644 --- a/src/Avalonia.Base/Rendering/Composition/CompositionTarget.cs +++ b/src/Avalonia.Base/Rendering/Composition/CompositionTarget.cs @@ -62,7 +62,7 @@ namespace Avalonia.Rendering.Composition bool TryGetInvertedTransform(CompositionVisual visual, out Matrix matrix) { - var m = visual.TryGetServerTransform(); + var m = visual.TryGetServerGlobalTransform(); if (m == null) { matrix = default; @@ -73,52 +73,44 @@ namespace Avalonia.Rendering.Composition return m33.TryInvert(out matrix); } - bool TryTransformTo(CompositionVisual visual, ref Point v) + bool TryTransformTo(CompositionVisual visual, Point globalPoint, out Point v) { + v = default; if (TryGetInvertedTransform(visual, out var m)) { - v = v * m; + v = globalPoint * m; return true; } return false; } - bool HitTestCore(CompositionVisual visual, Point point, PooledList result, + void HitTestCore(CompositionVisual visual, Point globalPoint, PooledList result, Func? filter) { - //TODO: Check readback too if (visual.Visible == false) - return false; - if (!TryTransformTo(visual, ref point)) - return false; + return; + if (!TryTransformTo(visual, globalPoint, out var point)) + return; if (visual.ClipToBounds && (point.X < 0 || point.Y < 0 || point.X > visual.Size.X || point.Y > visual.Size.Y)) - return false; - if (visual.Clip?.FillContains(point) == false) - return false; + return; - bool success = false; - // Hit-test the current node - if (visual.HitTest(point, filter)) - { - result.Add(visual); - success = true; - } - - // Inspect children too + if (visual.Clip?.FillContains(point) == false) + return; + + // Inspect children if (visual is CompositionContainerVisual cv) for (var c = cv.Children.Count - 1; c >= 0; c--) { var ch = cv.Children[c]; - var hit = HitTestCore(ch, point, result, filter); - if (hit) - return true; + HitTestCore(ch, globalPoint, result, filter); } - - return success; - + + // Hit-test the current node + if (visual.HitTest(point, filter)) + result.Add(visual); } /// diff --git a/src/Avalonia.Base/Rendering/Composition/ICompositionTargetDebugEvents.cs b/src/Avalonia.Base/Rendering/Composition/ICompositionTargetDebugEvents.cs new file mode 100644 index 0000000000..045a4f8cc6 --- /dev/null +++ b/src/Avalonia.Base/Rendering/Composition/ICompositionTargetDebugEvents.cs @@ -0,0 +1,6 @@ +namespace Avalonia.Rendering.Composition; + +internal interface ICompositionTargetDebugEvents +{ + void RectInvalidated(Rect rc); +} \ No newline at end of file diff --git a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionTarget.cs b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionTarget.cs index 0fde86e484..882b66bf70 100644 --- a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionTarget.cs +++ b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionTarget.cs @@ -33,7 +33,7 @@ namespace Avalonia.Rendering.Composition.Server private HashSet _attachedVisuals = new(); private Queue _adornerUpdateQueue = new(); - + public ICompositionTargetDebugEvents? DebugEvents { get; set; } public ReadbackIndices Readback { get; } = new(); public int RenderedVisuals { get; set; } @@ -173,6 +173,7 @@ namespace Avalonia.Rendering.Composition.Server if(rect.IsEmpty) return; var snapped = SnapToDevicePixels(rect, Scaling); + DebugEvents?.RectInvalidated(rect); _dirtyRect = _dirtyRect.Union(snapped); _redrawRequested = true; } diff --git a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionVisual.cs b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionVisual.cs index 6fdf105e58..c0e487f209 100644 --- a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionVisual.cs +++ b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositionVisual.cs @@ -119,14 +119,15 @@ namespace Avalonia.Rendering.Composition.Server var oldTransformedContentBounds = TransformedOwnContentBounds; var oldCombinedTransformedClipBounds = _combinedTransformedClipBounds; - - var dirtyOldBounds = false; + if (_parent?.IsDirtyComposition == true) { IsDirtyComposition = true; _isDirtyForUpdate = true; - dirtyOldBounds = true; } + + var invalidateOldBounds = _isDirtyForUpdate; + var invalidateNewBounds = _isDirtyForUpdate; GlobalTransformMatrix = newTransform; @@ -157,30 +158,20 @@ namespace Avalonia.Rendering.Composition.Server EffectiveOpacity = Opacity * (Parent?.EffectiveOpacity ?? 1); - IsVisibleInFrame = Visible && EffectiveOpacity > 0.04 && !_isBackface && + IsVisibleInFrame = _parent?.IsVisibleInFrame != false && Visible && EffectiveOpacity > 0.04 && !_isBackface && !_combinedTransformedClipBounds.IsEmpty; - - if (wasVisible != IsVisibleInFrame) - _isDirtyForUpdate = true; - - // Invalidate previous rect and queue new rect based on visibility - if (positionChanged) - { - if (wasVisible) - dirtyOldBounds = true; - if (IsVisibleInFrame) - _isDirtyForUpdate = true; + if (wasVisible != IsVisibleInFrame || positionChanged) + { + invalidateOldBounds |= wasVisible; + invalidateNewBounds |= IsVisibleInFrame; } - + // Invalidate new bounds - if (IsVisibleInFrame && _isDirtyForUpdate) - { - dirtyOldBounds = true; + if (invalidateNewBounds) AddDirtyRect(TransformedOwnContentBounds.Intersect(_combinedTransformedClipBounds)); - } - if (dirtyOldBounds && wasVisible) + if (invalidateOldBounds) AddDirtyRect(oldTransformedContentBounds.Intersect(oldCombinedTransformedClipBounds)); @@ -190,7 +181,7 @@ namespace Avalonia.Rendering.Composition.Server var i = Root!.Readback; ref var readback = ref GetReadback(i.WriteIndex); readback.Revision = root.Revision; - readback.Matrix = CombinedTransformMatrix; + readback.Matrix = GlobalTransformMatrix; readback.TargetId = Root.Id; readback.Visible = IsVisibleInFrame; } diff --git a/src/Avalonia.Base/Rendering/Composition/Transport/BatchStreamArrayPool.cs b/src/Avalonia.Base/Rendering/Composition/Transport/BatchStreamArrayPool.cs index 32b4ed3026..b0a89c6f92 100644 --- a/src/Avalonia.Base/Rendering/Composition/Transport/BatchStreamArrayPool.cs +++ b/src/Avalonia.Base/Rendering/Composition/Transport/BatchStreamArrayPool.cs @@ -1,8 +1,8 @@ using System; using System.Collections.Generic; using System.Linq; -using System.Runtime.ConstrainedExecution; using System.Runtime.InteropServices; +using Avalonia.Platform; using Avalonia.Threading; namespace Avalonia.Rendering.Composition.Transport; @@ -17,6 +17,7 @@ internal abstract class BatchStreamPoolBase : IDisposable int _usage; readonly int[] _usageStatistics = new int[10]; int _usageStatisticsSlot; + bool _reclaimImmediately; public int CurrentUsage => _usage; public int CurrentPool => _pool.Count; @@ -27,7 +28,10 @@ internal abstract class BatchStreamPoolBase : IDisposable GC.SuppressFinalize(needsFinalize); var updateRef = new WeakReference>(this); - StartUpdateTimer(startTimer, updateRef); + if (AvaloniaLocator.Current.GetService() == null) + _reclaimImmediately = true; + else + StartUpdateTimer(startTimer, updateRef); } static void StartUpdateTimer(Action>? startTimer, WeakReference> updateRef) @@ -90,7 +94,7 @@ internal abstract class BatchStreamPoolBase : IDisposable lock (_pool) { _usage--; - if (!_disposed) + if (!_disposed && !_reclaimImmediately) { _pool.Push(item); return; diff --git a/src/Avalonia.Base/Rendering/Composition/Visual.cs b/src/Avalonia.Base/Rendering/Composition/Visual.cs index f9e1eae2ab..7ebbb0aa96 100644 --- a/src/Avalonia.Base/Rendering/Composition/Visual.cs +++ b/src/Avalonia.Base/Rendering/Composition/Visual.cs @@ -31,7 +31,7 @@ namespace Avalonia.Rendering.Composition } } - internal Matrix4x4? TryGetServerTransform() + internal Matrix4x4? TryGetServerGlobalTransform() { if (Root == null) return null; diff --git a/tests/Avalonia.Base.UnitTests/Rendering/CompositorHitTestingTests.cs b/tests/Avalonia.Base.UnitTests/Rendering/CompositorHitTestingTests.cs new file mode 100644 index 0000000000..705c8fad9c --- /dev/null +++ b/tests/Avalonia.Base.UnitTests/Rendering/CompositorHitTestingTests.cs @@ -0,0 +1,417 @@ +using System; +using System.Linq; +using Avalonia.Controls; +using Avalonia.Controls.Presenters; +using Avalonia.Controls.Shapes; +using Avalonia.Layout; +using Avalonia.Media; +using Avalonia.Platform; +using Avalonia.Rendering; +using Avalonia.UnitTests; +using Avalonia.VisualTree; +using Moq; +using Xunit; + +namespace Avalonia.Base.UnitTests.Rendering; + +public class CompositorHitTestingTests : CompositorTestsBase +{ + + [Fact] + public void HitTest_Should_Find_Controls_At_Point() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + var border = new Border + { + Width = 100, + Height = 100, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }; + + s.TopLevel.Content = border; + + s.AssertHitTest(new Point(100, 100), null, border); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Empty_Controls_At_Point() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + var border = new Border + { + Width = 100, + Height = 100, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }; + + s.TopLevel.Content = border; + + s.AssertHitTest(new Point(100, 100), null); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Invisible_Controls_At_Point() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Border visible, border; + s.TopLevel.Content = border = new Border + { + Width = 100, + Height = 100, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center, + IsVisible = false, + Child = visible = new Border + { + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Stretch, + VerticalAlignment = VerticalAlignment.Stretch, + } + }; + + s.AssertHitTest(new Point(100, 100), null); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Control_Outside_Point() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + var border = new Border + { + Width = 100, + Height = 100, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + + }; + s.TopLevel.Content = border; + + s.AssertHitTest(new Point(10, 10), null); + } + } + + [Fact] + public void HitTest_Should_Return_Top_Controls_First() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Panel container = new Panel + { + Width = 200, + Height = 200, + Children = + { + new Border + { + Width = 100, + Height = 100, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }, + new Border + { + Width = 50, + Height = 50, + Background = Brushes.Blue, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + } + } + }; + s.TopLevel.Content = container; + + s.AssertHitTest(new Point(100, 100), null, container.Children[1], container.Children[0]); + } + } + + [Fact] + public void HitTest_Should_Return_Top_Controls_First_With_ZIndex() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Panel container = new Panel + { + Width = 200, + Height = 200, + Children = + { + new Border + { + Width = 100, + Height = 100, + ZIndex = 1, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }, + new Border + { + Width = 50, + Height = 50, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }, + new Border + { + Width = 75, + Height = 75, + ZIndex = 2, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + } + } + + }; + s.TopLevel.Content = container; + + s.AssertHitTest(new Point(100, 100), null, new[] { container.Children[2], container.Children[0], container.Children[1] }); + } + } + + [Fact] + public void HitTest_Should_Find_Control_Translated_Outside_Parent_Bounds() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Border target; + Panel container = new Panel + { + Width = 200, + Height = 200, + Background = Brushes.Red, + ClipToBounds = false, + Children = + { + new Border + { + Width = 100, + Height = 100, + ZIndex = 1, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Left, + VerticalAlignment = VerticalAlignment.Top, + Child = target = new Border + { + Width = 50, + Height = 50, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Left, + VerticalAlignment = VerticalAlignment.Top, + RenderTransform = new TranslateTransform(110, 110), + } + }, + } + }; + s.TopLevel.Content = container; + + s.AssertHitTest(new Point(120, 120), null, target, container); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Control_Outside_Parent_Bounds_When_Clipped() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Border target; + Panel container = new Panel + { + Width = 100, + Height = 200, + Background = Brushes.Red, + Children = + { + new Panel() + { + Width = 100, + Height = 100, + Background = Brushes.Red, + Margin = new Thickness(0, 100, 0, 0), + ClipToBounds = true, + Children = + { + (target = new Border() + { + Width = 100, + Height = 100, + Background = Brushes.Red, + Margin = new Thickness(0, -100, 0, 0) + }) + } + } + } + + }; + s.TopLevel.Content = container; + + s.AssertHitTest(new Point(50, 50), null, container); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Control_Outside_Scroll_Viewport() + { + using (var s = new CompositorServices(new Size(100, 200))) + { + Border target; + Border item1; + Border item2; + ScrollContentPresenter scroll; + Panel container = new Panel + { + Width = 100, + Height = 200, + Background = Brushes.Red, + Children = + { + (target = new Border() + { + Name = "b1", + Width = 100, + Height = 100, + Background = Brushes.Red, + }), + new Border() + { + Name = "b2", + Width = 100, + Height = 100, + Background = Brushes.Red, + Margin = new Thickness(0, 100, 0, 0), + Child = scroll = new ScrollContentPresenter() + { + CanHorizontallyScroll = true, + CanVerticallyScroll = true, + Content = new StackPanel() + { + Children = + { + (item1 = new Border() + { + Name = "b3", + Width = 100, + Height = 100, + Background = Brushes.Red, + }), + (item2 = new Border() + { + Name = "b4", + Width = 100, + Height = 100, + Background = Brushes.Red, + }), + } + } + } + } + } + }; + s.TopLevel.Content = container; + + scroll.UpdateChild(); + + s.AssertHitTestFirst(new Point(50, 150), null, item1); + + s.AssertHitTestFirst(new Point(50,50), null, target); + + scroll.Offset = new Vector(0, 100); + + s.AssertHitTestFirst(new Point(50, 150), null, item2); + + s.AssertHitTestFirst(new Point(50,50), null, target); + } + } + + [Fact] + public void HitTest_Should_Not_Find_Path_When_Outside_Fill() + { + using (var s = new CompositorServices(new Size(200, 200))) + { + Path path = new Path + { + Width = 200, + Height = 200, + Fill = Brushes.Red, + Data = StreamGeometry.Parse("M100,0 L0,100 100,100") + }; + s.TopLevel.Content = path; + + s.AssertHitTest(new Point(100, 100), null, path); + s.AssertHitTest(new Point(10, 10), null); + } + } + + [Fact] + public void HitTest_Should_Respect_Geometry_Clip() + { + using (var s = new CompositorServices(new Size(400, 400))) + { + Canvas canvas; + Border border = new Border + { + Background = Brushes.Red, + Clip = StreamGeometry.Parse("M100,0 L0,100 100,100"), + Width = 200, + Height = 200, + Child = canvas = new Canvas + { + Background = Brushes.Yellow, + Margin = new Thickness(10), + } + + }; + s.TopLevel.Content = border; + + s.RunJobs(); + Assert.Equal(new Rect(100, 100, 200, 200), border.Bounds); + + s.AssertHitTest(new Point(200,200), null, canvas, border); + + s.AssertHitTest(new Point(110, 110), null); + } + } + + [Fact] + public void HitTest_Should_Accommodate_ICustomHitTest() + { + using (var s = new CompositorServices(new Size(300, 200))) + { + Border border = new CustomHitTestBorder + { + ClipToBounds = false, + Width = 100, + Height = 100, + Background = Brushes.Red, + HorizontalAlignment = HorizontalAlignment.Center, + VerticalAlignment = VerticalAlignment.Center + }; + + s.TopLevel.Content = border; + + s.AssertHitTest(75, 100, null, border); + s.AssertHitTest(125, 100, null, border); + s.AssertHitTest(175, 100, null); + } + } + + private IDisposable TestApplication() + { + return UnitTestApplication.Start(TestServices.MockPlatformRenderInterface); + } + +} \ No newline at end of file diff --git a/tests/Avalonia.Base.UnitTests/Rendering/CompositorInvalidationTests.cs b/tests/Avalonia.Base.UnitTests/Rendering/CompositorInvalidationTests.cs new file mode 100644 index 0000000000..699f450223 --- /dev/null +++ b/tests/Avalonia.Base.UnitTests/Rendering/CompositorInvalidationTests.cs @@ -0,0 +1,109 @@ +using Avalonia.Controls; +using Avalonia.Media; +using Xunit; + +namespace Avalonia.Base.UnitTests.Rendering; + +public class CompositorInvalidationTests : CompositorTestsBase +{ + [Fact] + public void Control_Should_Invalidate_Own_Rect_When_Added() + { + using (var s = new CompositorCanvas()) + { + var control = new Border() + { + Background = Brushes.Red, Width = 20, Height = 10, + [Canvas.LeftProperty] = 30, [Canvas.TopProperty] = 50 + }; + s.Canvas.Children.Add(control); + s.AssertRects(new Rect(30, 50, 20, 10)); + } + } + + [Fact] + public void Control_Should_Invalidate_Own_Rect_When_Removed() + { + using (var s = new CompositorCanvas()) + { + var control = new Border() + { + Background = Brushes.Red, Width = 20, Height = 10, + [Canvas.LeftProperty] = 30, [Canvas.TopProperty] = 50 + }; + s.Canvas.Children.Add(control); + s.RunJobs(); + s.Events.Rects.Clear(); + s.Canvas.Children.Remove(control); + s.AssertRects(new Rect(30, 50, 20, 10)); + } + } + + [Fact] + public void Control_Should_Invalidate_Both_Own_Rects_When_Moved() + { + using (var s = new CompositorCanvas()) + { + var control = new Border() + { + Background = Brushes.Red, Width = 20, Height = 10, + [Canvas.LeftProperty] = 30, [Canvas.TopProperty] = 50 + }; + s.Canvas.Children.Add(control); + s.RunJobs(); + s.Events.Rects.Clear(); + control[Canvas.LeftProperty] = 55; + s.AssertRects(new Rect(30, 50, 20, 10), + new Rect(55, 50, 20, 10) + ); + } + } + + [Fact] + public void Control_Should_Invalidate_Child_Rects_When_Moved() + { + using (var s = new CompositorCanvas()) + { + var control = new Decorator() + { + [Canvas.LeftProperty] = 30, [Canvas.TopProperty] = 50, + Padding = new Thickness(10), + Child = new Border() + { + Width = 20, Height = 10, + Background = Brushes.Red + } + }; + s.Canvas.Children.Add(control); + s.RunJobs(); + s.Events.Rects.Clear(); + control[Canvas.LeftProperty] = 55; + s.AssertRects(new Rect(40, 60, 20, 10), + new Rect(65, 60, 20, 10) + ); + } + } + + [Fact] + public void Control_Should_Invalidate_Child_Rects_When_Becomes_Invisible() + { + using (var s = new CompositorCanvas()) + { + var control = new Decorator() + { + [Canvas.LeftProperty] = 30, [Canvas.TopProperty] = 50, + Padding = new Thickness(10), + Child = new Border() + { + Width = 20, Height = 10, + Background = Brushes.Red + } + }; + s.Canvas.Children.Add(control); + s.RunJobs(); + s.Events.Rects.Clear(); + control.IsVisible = false; + s.AssertRects(new Rect(40, 60, 20, 10)); + } + } +} \ No newline at end of file diff --git a/tests/Avalonia.Base.UnitTests/Rendering/CompositorTestsBase.cs b/tests/Avalonia.Base.UnitTests/Rendering/CompositorTestsBase.cs new file mode 100644 index 0000000000..fa722a23b8 --- /dev/null +++ b/tests/Avalonia.Base.UnitTests/Rendering/CompositorTestsBase.cs @@ -0,0 +1,208 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.Linq; +using System.Reactive.Disposables; +using System.Threading; +using System.Threading.Tasks; +using Avalonia.Controls; +using Avalonia.Controls.Embedding; +using Avalonia.Controls.Presenters; +using Avalonia.Controls.Templates; +using Avalonia.Data; +using Avalonia.Input; +using Avalonia.Input.Raw; +using Avalonia.Platform; +using Avalonia.Rendering; +using Avalonia.Rendering.Composition; +using Avalonia.Threading; +using Avalonia.UnitTests; +using Avalonia.VisualTree; +using JetBrains.Annotations; +using Xunit; + +namespace Avalonia.Base.UnitTests.Rendering; + +public class CompositorTestsBase +{ + public class DebugEvents : ICompositionTargetDebugEvents + { + public List Rects = new(); + + public void RectInvalidated(Rect rc) + { + Rects.Add(rc); + } + + public void Reset() + { + Rects.Clear(); + } + } + + public class ManualRenderTimer : IRenderTimer + { + public event Action Tick; + public bool RunsInBackground => false; + public void TriggerTick() => Tick?.Invoke(TimeSpan.Zero); + public Task TriggerBackgroundTick() => Task.Run(TriggerTick); + } + + class TopLevelImpl : ITopLevelImpl + { + private readonly Compositor _compositor; + public CompositingRenderer Renderer { get; private set; } + + public TopLevelImpl(Compositor compositor, Size clientSize) + { + ClientSize = clientSize; + _compositor = compositor; + } + + public void Dispose() + { + + } + + public Size ClientSize { get; } + public Size? FrameSize { get; } + public double RenderScaling => 1; + public IEnumerable Surfaces { get; } = Array.Empty(); + public Action Input { get; set; } + public Action Paint { get; set; } + public Action Resized { get; set; } + public Action ScalingChanged { get; set; } + public Action TransparencyLevelChanged { get; set; } + + public IRenderer CreateRenderer(IRenderRoot root) + { + return Renderer = new CompositingRenderer(root, _compositor); + } + + public void Invalidate(Rect rect) + { + } + + public void SetInputRoot(IInputRoot inputRoot) + { + } + + public Point PointToClient(PixelPoint point) => default; + + public PixelPoint PointToScreen(Point point) => new(); + + public void SetCursor(ICursorImpl cursor) + { + } + + public Action Closed { get; set; } + public Action LostFocus { get; set; } + public IMouseDevice MouseDevice { get; } = new MouseDevice(); + public IPopupImpl CreatePopup() => throw new NotImplementedException(); + + public void SetTransparencyLevelHint(WindowTransparencyLevel transparencyLevel) + { + } + + public WindowTransparencyLevel TransparencyLevel { get; } + public AcrylicPlatformCompensationLevels AcrylicCompensationLevels { get; } + } + + protected class CompositorServices : IDisposable + { + private readonly IDisposable _app; + public Compositor Compositor { get; } + public ManualRenderTimer Timer { get; } = new(); + public EmbeddableControlRoot TopLevel { get; } + public CompositingRenderer Renderer { get; } = null!; + public DebugEvents Events { get; } = new(); + + public void Dispose() + { + TopLevel.Renderer.Stop(); + TopLevel.Dispose(); + _app.Dispose(); + } + + public CompositorServices(Size? size = null) + { + _app = UnitTestApplication.Start(TestServices.MockPlatformRenderInterface); + try + { + AvaloniaLocator.CurrentMutable.Bind().ToConstant(Timer); + AvaloniaLocator.CurrentMutable.Bind() + .ToConstant(new RenderLoop(Timer, Dispatcher.UIThread)); + + Compositor = new Compositor(AvaloniaLocator.Current.GetRequiredService(), null); + var impl = new TopLevelImpl(Compositor, size ?? new Size(1000, 1000)); + TopLevel = new EmbeddableControlRoot(impl) + { + Template = new FuncControlTemplate((parent, scope) => + { + var presenter = new ContentPresenter + { + [~ContentPresenter.ContentProperty] = new TemplateBinding(ContentControl.ContentProperty) + }; + scope.Register("PART_ContentPresenter", presenter); + return presenter; + }) + }; + Renderer = impl.Renderer; + TopLevel.Prepare(); + TopLevel.Renderer.Start(); + RunJobs(); + Renderer.CompositionTarget.Server.DebugEvents = Events; + } + catch + { + _app.Dispose(); + throw; + } + } + + public void RunJobs() + { + Dispatcher.UIThread.RunJobs(); + Timer.TriggerTick(); + Dispatcher.UIThread.RunJobs(); + } + + public void AssertRects(params Rect[] rects) + { + RunJobs(); + var toAssert = rects.Select(x => x.ToString()).Distinct().OrderBy(x => x); + var invalidated = Events.Rects.Select(x => x.ToString()).Distinct().OrderBy(x => x); + Assert.Equal(toAssert, invalidated); + Events.Rects.Clear(); + } + + public void AssertHitTest(double x, double y, Func filter, params object[] expected) + => AssertHitTest(new Point(x, y), filter, expected); + public void AssertHitTest(Point pt, Func filter, params object[] expected) + { + RunJobs(); + var tested = Renderer.HitTest(pt, TopLevel, filter); + Assert.Equal(expected, tested); + } + + public void AssertHitTestFirst(Point pt, Func filter, object expected) + { + RunJobs(); + var tested = Renderer.HitTest(pt, TopLevel, filter).First(); + Assert.Equal(expected, tested); + } + } + + + protected class CompositorCanvas : CompositorServices + { + public Canvas Canvas { get; } = new(); + + public CompositorCanvas() + { + TopLevel.Content = Canvas; + RunJobs(); + Events.Reset(); + } + } +} \ No newline at end of file diff --git a/tests/Avalonia.UnitTests/MockPlatformRenderInterface.cs b/tests/Avalonia.UnitTests/MockPlatformRenderInterface.cs index bf4ac9c1f6..f6a127b573 100644 --- a/tests/Avalonia.UnitTests/MockPlatformRenderInterface.cs +++ b/tests/Avalonia.UnitTests/MockPlatformRenderInterface.cs @@ -4,6 +4,7 @@ using System.IO; using Avalonia.Media; using Avalonia.Platform; using Avalonia.Media.Imaging; +using Avalonia.Rendering; using Moq; namespace Avalonia.UnitTests @@ -25,9 +26,33 @@ namespace Avalonia.UnitTests return Mock.Of(x => x.Bounds == rect); } + class MockRenderTarget : IRenderTarget + { + public void Dispose() + { + + } + + public IDrawingContextImpl CreateDrawingContext(IVisualBrushRenderer visualBrushRenderer) + { + var m = new Mock(); + m.Setup(c => c.CreateLayer(It.IsAny())) + .Returns(() => + { + var r = new Mock(); + r.Setup(r => r.CreateDrawingContext(It.IsAny())) + .Returns(CreateDrawingContext(null)); + return r.Object; + } + ); + return m.Object; + + } + } + public IRenderTarget CreateRenderTarget(IEnumerable surfaces) { - return Mock.Of(); + return new MockRenderTarget(); } public IRenderTargetBitmapImpl CreateRenderTargetBitmap(PixelSize size, Vector dpi) From a51acea5e02ddde0a05c2102a45f48e395e314ae Mon Sep 17 00:00:00 2001 From: Dan Walmsley Date: Tue, 19 Jul 2022 15:32:37 +0100 Subject: [PATCH 03/20] MenuItem might have to look up the logical tree to find its menu parent (as in trayicon) --- src/Avalonia.Controls/MenuItem.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Avalonia.Controls/MenuItem.cs b/src/Avalonia.Controls/MenuItem.cs index 11c42f2ef3..5e7c83fcbd 100644 --- a/src/Avalonia.Controls/MenuItem.cs +++ b/src/Avalonia.Controls/MenuItem.cs @@ -304,7 +304,7 @@ namespace Avalonia.Controls bool IMenuItem.IsPointerOverSubMenu => _popup?.IsPointerOverPopup ?? false; /// - IMenuElement? IMenuItem.Parent => Parent as IMenuElement; + IMenuElement? IMenuItem.Parent => this.FindLogicalAncestorOfType(); protected override bool IsEnabledCore => base.IsEnabledCore && _commandCanExecute; From 961c693e343ee698227448da77823ec6d1dc2da2 Mon Sep 17 00:00:00 2001 From: Dan Walmsley Date: Wed, 20 Jul 2022 11:37:11 +0100 Subject: [PATCH 04/20] fix win32native to managed menu exporter. --- src/Avalonia.Controls/MenuItem.cs | 2 +- .../Win32NativeToManagedMenuExporter.cs | 13 +++++++++---- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/src/Avalonia.Controls/MenuItem.cs b/src/Avalonia.Controls/MenuItem.cs index 5e7c83fcbd..11c42f2ef3 100644 --- a/src/Avalonia.Controls/MenuItem.cs +++ b/src/Avalonia.Controls/MenuItem.cs @@ -304,7 +304,7 @@ namespace Avalonia.Controls bool IMenuItem.IsPointerOverSubMenu => _popup?.IsPointerOverPopup ?? false; /// - IMenuElement? IMenuItem.Parent => this.FindLogicalAncestorOfType(); + IMenuElement? IMenuItem.Parent => Parent as IMenuElement; protected override bool IsEnabledCore => base.IsEnabledCore && _commandCanExecute; diff --git a/src/Windows/Avalonia.Win32/Win32NativeToManagedMenuExporter.cs b/src/Windows/Avalonia.Win32/Win32NativeToManagedMenuExporter.cs index fa6f9927b5..da8357a6f1 100644 --- a/src/Windows/Avalonia.Win32/Win32NativeToManagedMenuExporter.cs +++ b/src/Windows/Avalonia.Win32/Win32NativeToManagedMenuExporter.cs @@ -1,4 +1,5 @@ using System.Collections.Generic; +using Avalonia.Collections; using Avalonia.Controls; using Avalonia.Controls.Platform; @@ -15,13 +16,15 @@ namespace Avalonia.Win32 _nativeMenu = nativeMenu; } - private IEnumerable Populate(NativeMenu nativeMenu) + private AvaloniaList Populate(NativeMenu nativeMenu) { + var result = new AvaloniaList(); + foreach (var menuItem in nativeMenu.Items) { if (menuItem is NativeMenuItemSeparator) { - yield return new MenuItem { Header = "-" }; + result.Add(new MenuItem { Header = "-" }); } else if (menuItem is NativeMenuItem item) { @@ -36,12 +39,14 @@ namespace Avalonia.Win32 newItem.Click += (_, __) => bridge.RaiseClicked(); } - yield return newItem; + result.Add(newItem); } } + + return result; } - public IEnumerable? GetMenu() + public AvaloniaList? GetMenu() { if (_nativeMenu != null) { From 949b7f2d9427e3922e43721a03f1acc13b209680 Mon Sep 17 00:00:00 2001 From: Max Katz Date: Tue, 19 Jul 2022 21:24:29 -0400 Subject: [PATCH 05/20] Call GetHicon only once when creation a windows icon --- src/Windows/Avalonia.Win32/IconImpl.cs | 20 +++----------------- src/Windows/Avalonia.Win32/TrayIconImpl.cs | 4 +++- src/Windows/Avalonia.Win32/Win32Platform.cs | 8 ++++++-- 3 files changed, 12 insertions(+), 20 deletions(-) diff --git a/src/Windows/Avalonia.Win32/IconImpl.cs b/src/Windows/Avalonia.Win32/IconImpl.cs index 8548801555..4d2b89b0cc 100644 --- a/src/Windows/Avalonia.Win32/IconImpl.cs +++ b/src/Windows/Avalonia.Win32/IconImpl.cs @@ -1,6 +1,5 @@ using System; using System.Drawing; -using System.Drawing.Imaging; using System.IO; using Avalonia.Platform; @@ -8,31 +7,18 @@ namespace Avalonia.Win32 { class IconImpl : IWindowIconImpl { - private Bitmap bitmap; - private Icon icon; - - public IconImpl(Bitmap bitmap) - { - this.bitmap = bitmap; - } + private readonly Icon icon; public IconImpl(Icon icon) { this.icon = icon; } - public IntPtr HIcon => icon?.Handle ?? bitmap.GetHicon(); + public IntPtr HIcon => icon.Handle; public void Save(Stream outputStream) { - if (icon != null) - { - icon.Save(outputStream); - } - else - { - bitmap.Save(outputStream, ImageFormat.Png); - } + icon.Save(outputStream); } } } diff --git a/src/Windows/Avalonia.Win32/TrayIconImpl.cs b/src/Windows/Avalonia.Win32/TrayIconImpl.cs index 4d537a16a4..346d6e5adb 100644 --- a/src/Windows/Avalonia.Win32/TrayIconImpl.cs +++ b/src/Windows/Avalonia.Win32/TrayIconImpl.cs @@ -18,6 +18,8 @@ namespace Avalonia.Win32 [Unstable] public class TrayIconImpl : ITrayIconImpl { + private static readonly IntPtr s_emptyIcon = new System.Drawing.Bitmap(32, 32).GetHicon(); + private readonly int _uniqueId; private static int s_nextUniqueId; private bool _iconAdded; @@ -86,7 +88,7 @@ namespace Avalonia.Win32 uID = _uniqueId, uFlags = NIF.TIP | NIF.MESSAGE, uCallbackMessage = (int)CustomWindowsMessage.WM_TRAYMOUSE, - hIcon = _icon?.HIcon ?? new IconImpl(new System.Drawing.Bitmap(32, 32)).HIcon, + hIcon = _icon?.HIcon ?? s_emptyIcon, szTip = _tooltipText ?? "" }; diff --git a/src/Windows/Avalonia.Win32/Win32Platform.cs b/src/Windows/Avalonia.Win32/Win32Platform.cs index 73ef50052c..2b8070fb04 100644 --- a/src/Windows/Avalonia.Win32/Win32Platform.cs +++ b/src/Windows/Avalonia.Win32/Win32Platform.cs @@ -359,7 +359,7 @@ namespace Avalonia.Win32 using (var memoryStream = new MemoryStream()) { bitmap.Save(memoryStream); - return new IconImpl(new System.Drawing.Bitmap(memoryStream)); + return CreateIconImpl(memoryStream); } } @@ -367,11 +367,15 @@ namespace Avalonia.Win32 { try { + // new Icon() will work only if stream is an "ico" file. return new IconImpl(new System.Drawing.Icon(stream)); } catch (ArgumentException) { - return new IconImpl(new System.Drawing.Bitmap(stream)); + // Fallback to Bitmap creation and converting into a windows icon. + using var icon = new System.Drawing.Bitmap(stream); + var hIcon = icon.GetHicon(); + return new IconImpl(System.Drawing.Icon.FromHandle(hIcon)); } } From 62d1b4f3b69eb97460a0c3bc0999caff8ed16ecb Mon Sep 17 00:00:00 2001 From: Max Katz Date: Tue, 19 Jul 2022 23:25:37 -0400 Subject: [PATCH 06/20] Add missing IsEnabled binding --- src/Avalonia.Themes.Default/Controls/NativeMenuBar.xaml | 1 + src/Avalonia.Themes.Fluent/Controls/NativeMenuBar.xaml | 1 + 2 files changed, 2 insertions(+) diff --git a/src/Avalonia.Themes.Default/Controls/NativeMenuBar.xaml b/src/Avalonia.Themes.Default/Controls/NativeMenuBar.xaml index 81bd8f39c5..3b0019eea1 100644 --- a/src/Avalonia.Themes.Default/Controls/NativeMenuBar.xaml +++ b/src/Avalonia.Themes.Default/Controls/NativeMenuBar.xaml @@ -14,6 +14,7 @@