Merge branch 'master' of https://github.com/corvinsz/MaterialDesignInXamlToolkit

Author: Corvin Szimion

docs/Optimizing-WPF-Rendering-Performance.md

@@ -0,0 +1,70 @@
+[Home](..\README.md) > Optimizing WPF UI Animation and Rendering Performance
+
+---
+
+# Optimizing WPF UI Animation and Rendering Performance
+
+## Background Information
+
+WPF applications often have complex animations and UI interactions, which can lead to performance bottlenecks if not optimized. Understanding the techniques for efficient rendering and leveraging WPF's internal capabilities can significantly enhance the user experience by making the interface smoother and more responsive.
+
+## Reducing Visual Complexity
+
+One effective approach to improving rendering performance is reducing visual complexity. This involves:
+
+- **Minimizing Visual Layers**: Each layer that a control or element has can add rendering overhead. Consider consolidating overlapping elements.
+- **Avoiding Overdraw**: Redundant drawing layers, where multiple visual elements overlap, increase rendering work for the GPU. Arrange visuals to reduce the overdraw effect.
+- **Limiting the Use of Effects**: Avoid heavy effects such as `DropShadowEffect` or `BlurEffect` where possible, as these can slow down rendering.
+
+## Using the `RenderOptions` Property
+
+The `RenderOptions` class in WPF provides properties for fine-tuning rendering options. The `BitmapScalingMode` property, for instance, helps adjust the scaling performance of images.
+
+```xaml
+<Image Source="sample.png" RenderOptions.BitmapScalingMode="LowQuality" />
+```
+
+Setting `BitmapScalingMode` to `LowQuality` helps improve performance when scaling images, especially useful for animations.
+
+> [!TIP]
+> Use `HighQuality` scaling mode sparingly, as it increases GPU workload.
+
+## Implementing Virtualization
+
+For controls that display large data sets, such as `ListView` or `DataGrid`, enable virtualization to improve scrolling performance:
+
+```xaml
+<ListView VirtualizingStackPanel.IsVirtualizing="True" 
+          VirtualizingStackPanel.VirtualizationMode="Recycling" />
+```
+
+Virtualization helps reduce memory usage by creating only the items currently in view, thus speeding up scrolling and rendering.
+
+## Optimize Animation with CompositionTarget
+
+For custom animations, consider leveraging `CompositionTarget.Rendering`, which allows you to hook into the render loop directly:
+
+```csharp
+CompositionTarget.Rendering += (s, e) =>
+{
+    // Custom animation logic
+};
+```
+
+This method provides more control over frame-by-frame updates, but should be used cautiously as it can impact performance if not handled efficiently.
+
+## Example Comparison
+
+| Method                             | Performance Impact                                                                                   |
+| ---------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| Reducing Visual Layers             | Lowers CPU and GPU workload by limiting the number of visual elements rendered                       |
+| Using `RenderOptions.BitmapScalingMode` | Improves image scaling performance, particularly during animation                                  |
+| Enabling Virtualization            | Optimizes scrolling in large data sets, leading to faster rendering times                           |
+| `CompositionTarget` for Animations | Provides smoother animations at the expense of higher complexity; best suited for high-priority elements |
+
+## Further Reading
+
+Additional resources for improving WPF performance:
+- [Optimizing WPF Application Performance](https://learn.microsoft.com/dotnet/desktop/wpf/advanced/optimizing-wpf-application-performance?view=netdesktop-7.0)
+- [Rendering Performance Best Practices](https://learn.microsoft.com/dotnet/desktop/wpf/graphics-multimedia/rendering-performance-best-practices?view=netdesktop-7.0)
+

src/MainDemo.Wpf/Buttons.xaml.cs

@@ -1,5 +1,5 @@
 using System.Diagnostics;
-using MaterialDesignDemo.Domain;
+using MaterialDesignDemo.Shared.Domain;
 
 namespace MaterialDesignDemo;
 
@@ -25,7 +25,7 @@ private void CountingButton_OnClick(object sender, RoutedEventArgs e)
         if (CountingBadge.Badge == null || Equals(CountingBadge.Badge, string.Empty))
             CountingBadge.Badge = 0;
 
-        var next = int.Parse(CountingBadge.Badge.ToString() ?? "0") + 1;
+        int next = int.Parse(CountingBadge.Badge.ToString() ?? "0") + 1;
 
         CountingBadge.Badge = next < 21 ? (object)next : null;
     }

src/MaterialDesign3.Demo.Wpf/Buttons.xaml.cs

@@ -1,5 +1,5 @@
 using System.Diagnostics;
-using MaterialDesign3Demo.Domain;
+using MaterialDesignDemo.Shared.Domain;
 
 namespace MaterialDesign3Demo;
 

src/MaterialDesign3.Demo.Wpf/Domain/ButtonsViewModel.cs

@@ -72,7 +72,7 @@ public static DocumentationLink DemoPageLink<TDemoPage>(string? label, string? @
 
         return new DocumentationLink(
             DocumentationLinkType.DemoPageSource,
-            $"{ConfigurationManager.AppSettings["GitHub"]}/blob/master/MaterialDesign3.Demo.Wpf/{(string.IsNullOrWhiteSpace(@namespace) ? "" : "/" + @namespace + "/")}{typeof(TDemoPage).Name}.{ext}",
+            $"{ConfigurationManager.AppSettings["GitHub"]}/blob/master/src/MaterialDesign3.Demo.Wpf/{(string.IsNullOrWhiteSpace(@namespace) ? "" : "/" + @namespace + "/")}{typeof(TDemoPage).Name}.{ext}",
             label ?? typeof(TDemoPage).Name);
     }
 

src/MaterialDesign3.Demo.Wpf/Domain/DocumentationLink.cs

@@ -2,9 +2,8 @@
 using System.Windows.Threading;
 using CommunityToolkit.Mvvm.ComponentModel;
 using CommunityToolkit.Mvvm.Input;
-using MaterialDesignDemo.Shared.Domain;
 
-namespace MaterialDesignDemo.Domain;
+namespace MaterialDesignDemo.Shared.Domain;
 
 public sealed partial class ButtonsViewModel : ObservableObject
 {    

…/MainDemo.Wpf/Domain/ButtonsViewModel.cs …gnDemo.Shared/Domain/ButtonsViewModel.cssrc/MainDemo.Wpf/Domain/ButtonsViewModel.cs renamed to src/MaterialDesignDemo.Shared/Domain/ButtonsViewModel.cs src/MainDemo.Wpf/Domain/ButtonsViewModel.cs renamed to src/MaterialDesignDemo.Shared/Domain/ButtonsViewModel.cs

@@ -6,6 +6,10 @@
     <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="CommunityToolkit.Mvvm" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\MaterialDesignColors.Wpf\MaterialDesignColors.Wpf.csproj" />
     <ProjectReference Include="..\MaterialDesignThemes.Wpf\MaterialDesignThemes.Wpf.csproj" />