Merge pull request #291 from sirdoombox/main

Implement software rendering fallback.

SukiUI.Demo/Controls/LoadingTest.cs

@@ -63,6 +63,11 @@ protected override void Render(SKCanvas canvas, SKRect rect)
                 }
                 canvas.Restore();
             }
+
+            protected override void RenderSoftware(SKCanvas canvas, SKRect rect)
+            {
+                throw new System.NotImplementedException();
+            }
         }
     }
 

SukiUI.Demo/Features/Effects/ShaderToyRenderer.cs

@@ -50,6 +50,11 @@ protected override void Render(SKCanvas canvas, SKRect rect)
                 }
                 canvas.Restore();
             }
+
+            protected override void RenderSoftware(SKCanvas canvas, SKRect rect)
+            {
+                throw new System.NotImplementedException();
+            }
         }
     }
 }

SukiUI.Demo/SukiUIDemoViewModel.cs

@@ -133,6 +133,7 @@ private void ToggleWindowLock()
     [RelayCommand]
     private void ToggleTitleBar()
     {
+        TitleBarVisible = !TitleBarVisible;
         ToastManager.CreateSimpleInfoToast()
             .WithTitle($"Title Bar {(TitleBarVisible ? "Visible" : "Hidden")}")
             .WithContent($"Window title bar has been {(TitleBarVisible ? "shown" : "hidden")}.")

SukiUI/Controls/SukiBackground.cs

@@ -88,6 +88,14 @@ public double TransitionTime
             get => GetValue(TransitionTimeProperty);
             set => SetValue(TransitionTimeProperty, value);
         }
+
+        public static readonly StyledProperty<bool> ForceSoftwareRenderingProperty = AvaloniaProperty.Register<SukiBackground, bool>(nameof(ForceSoftwareRendering));
+
+        public bool ForceSoftwareRendering
+        {
+            get => GetValue(ForceSoftwareRenderingProperty);
+            set => SetValue(ForceSoftwareRenderingProperty, value);
+        }
 
         private readonly EffectBackgroundDraw _draw;
         private readonly IDisposable _observables;
@@ -96,9 +104,13 @@ public SukiBackground()
         {
             IsHitTestVisible = false;
             _draw = new EffectBackgroundDraw(new Rect(0, 0, Bounds.Width, Bounds.Height));
+            var forceSwRenderingObs = this.GetObservable(ForceSoftwareRenderingProperty)
+                .Do(enabled => _draw.ForceSoftwareRendering = enabled)
+                .Select(_ => Unit.Default);
             var transEnabledObs = this.GetObservable(TransitionsEnabledProperty)
                 .Do(enabled => _draw.TransitionsEnabled = enabled)
-                .Select(_ => Unit.Default);
+                .Select(_ => Unit.Default)
+                .Merge(forceSwRenderingObs);
             var transTime = this.GetObservable(TransitionTimeProperty)
                 .Do(time => _draw.TransitionTime = time)
                 .Select(_ => Unit.Default)

SukiUI/Controls/SukiWindow.axaml

@@ -36,7 +36,8 @@
                                                  ShaderFile="{TemplateBinding BackgroundShaderFile}"
                                                  Style="{TemplateBinding BackgroundStyle}"
                                                  TransitionTime="{TemplateBinding BackgroundTransitionTime}"
-                                                 TransitionsEnabled="{TemplateBinding BackgroundTransitionsEnabled}" />
+                                                 TransitionsEnabled="{TemplateBinding BackgroundTransitionsEnabled}" 
+                                                 ForceSoftwareRendering="{TemplateBinding BackgroundForceSoftwareRendering}"/>
                             <Panel Background="White"
                                    IsVisible="{DynamicResource IsLight}"
                                    Opacity="0.1" />

SukiUI/Controls/SukiWindow.axaml.cs

@@ -175,6 +175,18 @@ public double BackgroundTransitionTime
         AvaloniaProperty.Register<SukiWindow, Avalonia.Controls.Controls>(nameof(RightWindowTitleBarControls), 
             defaultValue: new Avalonia.Controls.Controls());
 
+    public static readonly StyledProperty<bool> BackgroundForceSoftwareRenderingProperty = AvaloniaProperty.Register<SukiWindow, bool>(nameof(BackgroundForceSoftwareRendering));
+
+    /// <summary>
+    /// Forces the background of the window to utilise software rendering.
+    /// This prevents use of any advanced effects or animations and provides only a flat background colour that changes with the theme.
+    /// </summary>
+    public bool BackgroundForceSoftwareRendering
+    {
+        get => GetValue(BackgroundForceSoftwareRenderingProperty);
+        set => SetValue(BackgroundForceSoftwareRenderingProperty, value);
+    }
+
     /// <summary>
     /// Controls that are displayed on the right side of the title bar,
     /// to the left of the normal window control buttons. (Displays provided controls right-to-left)

SukiUI/Utilities/Effects/EffectBackgroundDraw.cs

@@ -1,6 +1,8 @@
 using System;
 using System.Diagnostics;
 using Avalonia;
+using Avalonia.Skia;
+using Avalonia.Styling;
 using SkiaSharp;
 
 namespace SukiUI.Utilities.Effects
@@ -61,6 +63,14 @@ protected override void Render(SKCanvas canvas, SKRect rect)
             }
         }
 
+        protected override void RenderSoftware(SKCanvas canvas, SKRect rect)
+        {
+            if (ActiveVariant == ThemeVariant.Dark)
+                canvas.Clear(ActiveTheme.Background.ToSKColor());
+            else
+                canvas.Clear(new SKColorF(0.95f, 0.95f, 0.95f, 1f));
+        }
+
         private static double InverseLerp(double start, double end, double value) =>
             Math.Max(0, Math.Min(1, (value - start) / (end - start)));
     }

SukiUI/Utilities/Effects/EffectDrawBase.cs

@@ -7,6 +7,7 @@
 using Avalonia.Skia;
 using Avalonia.Styling;
 using SkiaSharp;
+using SukiUI.Models;
 
 namespace SukiUI.Utilities.Effects
 {
@@ -39,11 +40,15 @@ public bool AnimationEnabled
                 _animationEnabled = value;
             }
         }
+
+        public bool ForceSoftwareRendering { get; set; }
 
         protected float AnimationSpeedScale { get; set; } = 0.1f;
 
         protected ThemeVariant ActiveVariant { get; private set; }
 
+        protected SukiColorTheme ActiveTheme { get; private set; }
+
         protected float AnimationSeconds => (float)_animationTick.Elapsed.TotalSeconds;
 
         private readonly Stopwatch _animationTick = Stopwatch.StartNew();
@@ -53,18 +58,33 @@ protected EffectDrawBase(Rect bounds)
             Bounds = bounds;
             var sTheme = SukiTheme.GetInstance();
             sTheme.OnBaseThemeChanged += v => ActiveVariant = v;
-            ActiveVariant = SukiTheme.GetInstance().ActiveBaseTheme;
+            ActiveVariant = sTheme.ActiveBaseTheme;
+            sTheme.OnColorThemeChanged += t => ActiveTheme = t;
+            ActiveTheme = sTheme.ActiveColorTheme!;
+
         }
 
         public void Render(ImmediateDrawingContext context)
         {
             var leaseFeature = context.TryGetFeature<ISkiaSharpApiLeaseFeature>();
             if (leaseFeature is null) throw new InvalidOperationException("Unable to lease Skia API");
             using var lease = leaseFeature.Lease();
-            Render(lease.SkCanvas, SKRect.Create((float)Bounds.Width, (float)Bounds.Height));
+            var rect = SKRect.Create((float)Bounds.Width, (float)Bounds.Height);
+            if(lease.GrContext is null || ForceSoftwareRendering) // GrContext is null whenever
+                RenderSoftware(lease.SkCanvas, rect);
+            else
+                Render(lease.SkCanvas, rect);
         }
 
+        /// <summary>
+        /// Called every frame to render content.
+        /// </summary>
         protected abstract void Render(SKCanvas canvas, SKRect rect);
+
+        /// <summary>
+        /// Called every frame whenever the app falls back to software rendering (or <see cref="ForceSoftwareRendering"/> is enabled)
+        /// </summary>
+        protected abstract void RenderSoftware(SKCanvas canvas, SKRect rect);
 
         protected SKShader? EffectWithUniforms(float alpha = 1f) => 
             EffectWithUniforms(Effect, alpha);