GPU interop features now don't require to skip the first frame and av…

…ailable earlier in general (#14651) # Conflicts: # src/iOS/Avalonia.iOS/Platform.cs
AvaloniaUI · Feb 24, 2024 · b229779 · b229779
1 parent 760c674
commit b229779
Show file tree

Hide file tree

Showing 13 changed files with 139 additions and 22 deletions.
diff --git a/src/Android/Avalonia.Android/AndroidPlatform.cs b/src/Android/Avalonia.Android/AndroidPlatform.cs
@@ -90,6 +90,7 @@ public static void Initialize()
             }
 
             Compositor = new Compositor(graphics);
+            AvaloniaLocator.CurrentMutable.Bind<Compositor>().ToConstant(Compositor);
         }
 
         private static IPlatformGraphics InitializeGraphics(AndroidPlatformOptions opts)

diff --git a/src/Avalonia.Base/Platform/IPlatformRenderInterface.cs b/src/Avalonia.Base/Platform/IPlatformRenderInterface.cs
@@ -217,5 +217,10 @@ public interface IPlatformRenderInterfaceContext : IOptionalFeatureProvider, IDi
         /// Indicates that the context is no longer usable. This method should be thread-safe
         /// </summary>
         bool IsLost { get; }
+
+        /// <summary>
+        /// Exposes features that should be available for consumption while context isn't active (e. g. from the UI thread)
+        /// </summary>
+        IReadOnlyDictionary<Type, object> PublicFeatures { get; }
     }
 }
diff --git a/src/Avalonia.Base/Rendering/Composition/Compositor.cs b/src/Avalonia.Base/Rendering/Composition/Compositor.cs
@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using Avalonia.Animation;
 using Avalonia.Animation.Easings;
+using Avalonia.Controls;
 using Avalonia.Media;
 using Avalonia.Metadata;
 using Avalonia.Platform;
@@ -256,33 +257,56 @@ internal Task<T> InvokeServerJobAsync<T>(Func<T> job)
             return tcs.Task;
         }
 
+        internal ValueTask<IReadOnlyDictionary<Type, object>> GetRenderInterfacePublicFeatures()
+        {
+            if (Server.AT_TryGetCachedRenderInterfaceFeatures() is { } rv)
+                return new(rv);
+            if (!Loop.RunsInBackground)
+                return new(Server.RT_GetRenderInterfaceFeatures());
+            return new(InvokeServerJobAsync(Server.RT_GetRenderInterfaceFeatures));
+        }
+
         /// <summary>
         /// Attempts to query for a feature from the platform render interface
         /// </summary>
-        public ValueTask<object?> TryGetRenderInterfaceFeature(Type featureType) =>
-            new(InvokeServerJobAsync(() =>
-            {
-                using (Server.RenderInterface.EnsureCurrent())
-                {
-                    return Server.RenderInterface.Value.TryGetFeature(featureType);
-                }
-            }));
+        public async ValueTask<object?> TryGetRenderInterfaceFeature(Type featureType)
+        {
+            (await GetRenderInterfacePublicFeatures().ConfigureAwait(false)).TryGetValue(featureType, out var rv);
+            return rv;
+        }
+
+        /// <summary>
+        /// Attempts to query for GPU interop feature from the platform render interface
+        /// </summary>
+        /// <returns></returns>
+        public async ValueTask<ICompositionGpuInterop?> TryGetCompositionGpuInterop()
+        {
+            var externalObjects =
+                (IExternalObjectsRenderInterfaceContextFeature?)await TryGetRenderInterfaceFeature(
+                    typeof(IExternalObjectsRenderInterfaceContextFeature)).ConfigureAwait(false);
 
-        public ValueTask<ICompositionGpuInterop?> TryGetCompositionGpuInterop() =>
-            new(InvokeServerJobAsync<ICompositionGpuInterop?>(() =>
-            {
-                using (Server.RenderInterface.EnsureCurrent())
-                {
-                    var feature = Server.RenderInterface.Value
-                        .TryGetFeature<IExternalObjectsRenderInterfaceContextFeature>();
-                    if (feature == null)
-                        return null;
-                    return new CompositionInterop(this, feature);
-                }
-            }));
+            if (externalObjects == null)
+                return null;
+            return new CompositionInterop(this, externalObjects);
+        }
 
         internal bool UnitTestIsRegisteredForSerialization(ICompositorSerializable serializable) =>
             _objectSerializationHashSet.Contains(serializable);
+
+        /// <summary>
+        /// Attempts to get the Compositor instance that will be used by default for new <see cref="Avalonia.Controls.TopLevel"/>s
+        /// created by the current platform backend.
+        ///
+        /// This won't work for every single platform backend and backend settings, e. g. with web we'll need to have
+        /// separate Compositor instances per output HTML canvas since they don't share OpenGL state.
+        /// Another case where default compositor won't be available is our planned multithreaded rendering mode
+        /// where each window would get its own Compositor instance
+        ///
+        /// This method is still useful for obtaining GPU device LUID to speed up initialization, but you should
+        /// always check if default Compositor matches one used by our control once it gets attached to a TopLevel
+        /// </summary>
+        /// <returns></returns>
+        public static Compositor? TryGetDefaultCompositor() => AvaloniaLocator.Current.GetService<Compositor>();
     }
 
     internal interface ICompositorScheduler

diff --git a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositor.UserApis.cs b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositor.UserApis.cs
@@ -0,0 +1,50 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Avalonia.Platform;
+using Avalonia.Utilities;
+
+namespace Avalonia.Rendering.Composition.Server;
+
+internal partial class ServerCompositor
+{
+    private IReadOnlyDictionary<Type, object>? _renderInterfaceFeatureCache;
+    private readonly object _renderInterfaceFeaturesUserApiLock = new();
+
+    void RT_OnContextCreated(IPlatformRenderInterfaceContext context)
+    {
+        lock (_renderInterfaceFeaturesUserApiLock)
+        {
+            _renderInterfaceFeatureCache = null;
+            _renderInterfaceFeatureCache = context.PublicFeatures.ToDictionary(x => x.Key, x => x.Value);
+        }
+    }
+
+    bool RT_OnContextLostExceptionFilterObserver(Exception e)
+    {
+        if (e is PlatformGraphicsContextLostException)
+        {
+            lock (_renderInterfaceFeaturesUserApiLock)
+                _renderInterfaceFeatureCache = null;
+        }
+        return false;
+    }
+
+    void RT_OnContextDisposed()
+    {
+        lock (_renderInterfaceFeaturesUserApiLock)
+            _renderInterfaceFeatureCache = null;
+    }
+
+    public IReadOnlyDictionary<Type, object>? AT_TryGetCachedRenderInterfaceFeatures()
+    {
+        lock (_renderInterfaceFeaturesUserApiLock)
+            return _renderInterfaceFeatureCache;
+    }
+
+    public IReadOnlyDictionary<Type, object> RT_GetRenderInterfaceFeatures()
+    {
+        lock (_renderInterfaceFeaturesUserApiLock)
+            return _renderInterfaceFeatureCache ??= RenderInterface.Value.PublicFeatures;
+    }
+}
diff --git a/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositor.cs b/src/Avalonia.Base/Rendering/Composition/Server/ServerCompositor.cs
@@ -44,6 +44,8 @@ internal partial class ServerCompositor : IRenderLoopTask
         {
             _renderLoop = renderLoop;
             RenderInterface = new PlatformRenderInterfaceContextManager(platformGraphics);
+            RenderInterface.ContextDisposed += RT_OnContextDisposed;
+            RenderInterface.ContextCreated += RT_OnContextCreated;
             BatchObjectPool = batchObjectPool;
             BatchMemoryPool = batchMemoryPool;
             _renderLoop.Add(this);
@@ -187,6 +189,10 @@ private void RenderReentrancySafe()
                         _safeThread = Thread.CurrentThread;
                         RenderCore();
                     }
+                    catch (Exception e) when (RT_OnContextLostExceptionFilterObserver(e) && false)
+                    // Will never get here, only using exception filter side effect
+                    {
+                    }
                     finally
                     {
                         NotifyBatchesRendered();

diff --git a/src/Avalonia.Base/Rendering/PlatformRenderInterfaceContextManager.cs b/src/Avalonia.Base/Rendering/PlatformRenderInterfaceContextManager.cs
@@ -11,6 +11,8 @@ internal class PlatformRenderInterfaceContextManager
     private readonly IPlatformGraphics? _graphics;
     private IPlatformRenderInterfaceContext? _backend;
     private OwnedDisposable<IPlatformGraphicsContext>? _gpuContext;
+    public event Action? ContextDisposed;
+    public event Action<IPlatformRenderInterfaceContext>? ContextCreated;
 
     public PlatformRenderInterfaceContextManager(IPlatformGraphics? graphics)
     {
@@ -23,8 +25,12 @@ public void EnsureValidBackendContext()
         {
             _backend?.Dispose();
             _backend = null;
-            _gpuContext?.Dispose();
-            _gpuContext = null;
+            if (_gpuContext != null)
+            {
+                _gpuContext?.Dispose();
+                _gpuContext = null;
+                ContextDisposed?.Invoke();
+            }
 
             if (_graphics != null)
             {
@@ -36,6 +42,7 @@ public void EnsureValidBackendContext()
 
             _backend = AvaloniaLocator.Current.GetRequiredService<IPlatformRenderInterface>()
                 .CreateBackendContext(_gpuContext?.Value);
+            ContextCreated?.Invoke(_backend);
         }
     }
 

diff --git a/src/Avalonia.Native/AvaloniaNativePlatform.cs b/src/Avalonia.Native/AvaloniaNativePlatform.cs
@@ -161,6 +161,7 @@ void DoInitialize(AvaloniaNativePlatformOptions options)
 
 
             Compositor = new Compositor(_platformGraphics, true);
+            AvaloniaLocator.CurrentMutable.Bind<Compositor>().ToConstant(Compositor);
 
             AppDomain.CurrentDomain.ProcessExit += OnProcessExit;
         }

diff --git a/src/Avalonia.X11/X11Platform.cs b/src/Avalonia.X11/X11Platform.cs
@@ -96,6 +96,7 @@ public void Initialize(X11PlatformOptions options)
             }
 
             Compositor = new Compositor(graphics);
+            AvaloniaLocator.CurrentMutable.Bind<Compositor>().ToConstant(Compositor);
         }
 
         public IntPtr DeferredDisplay { get; set; }

diff --git a/src/Headless/Avalonia.Headless/HeadlessPlatformRenderInterface.cs b/src/Headless/Avalonia.Headless/HeadlessPlatformRenderInterface.cs
@@ -53,6 +53,7 @@ public IGeometryImpl CreateRectangleGeometry(Rect rect)
 
         public IRenderTarget CreateRenderTarget(IEnumerable<object> surfaces) => new HeadlessRenderTarget();
         public bool IsLost => false;
+        public IReadOnlyDictionary<Type, object> PublicFeatures { get; } = new Dictionary<Type, object>();
         public object? TryGetFeature(Type featureType) => null;
 
         public IRenderTargetBitmapImpl CreateRenderTargetBitmap(PixelSize size, Vector dpi)

diff --git a/src/Skia/Avalonia.Skia/SkiaBackendContext.cs b/src/Skia/Avalonia.Skia/SkiaBackendContext.cs
@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Avalonia.Controls.Platform.Surfaces;
+using Avalonia.OpenGL;
 using Avalonia.Platform;
 
 namespace Avalonia.Skia;
@@ -14,6 +15,22 @@ internal class SkiaContext : IPlatformRenderInterfaceContext
     public SkiaContext(ISkiaGpu? gpu)
     {
         _gpu = gpu;
+
+        var features = new Dictionary<Type, object>();
+
+        if (gpu != null)
+        {
+            void TryFeature<T>() where T : class
+            {
+                if (gpu!.TryGetFeature<T>() is { } feature)
+                    features!.Add(typeof(T), feature);
+            }
+            // TODO12: extend ISkiaGpu with PublicFeatures instead
+            TryFeature<IOpenGlTextureSharingRenderInterfaceContextFeature>();
+            TryFeature<IExternalObjectsRenderInterfaceContextFeature>();
+        }
+
+        PublicFeatures = features;
     }
 
     public void Dispose()
@@ -44,6 +61,7 @@ public IRenderTarget CreateRenderTarget(IEnumerable<object> surfaces)
     }
 
     public bool IsLost => _gpu?.IsLost ?? false;
+    public IReadOnlyDictionary<Type, object> PublicFeatures { get; }
 
     public object? TryGetFeature(Type featureType) => _gpu?.TryGetFeature(featureType);
 }
diff --git a/src/Windows/Avalonia.Direct2D1/Direct2D1Platform.cs b/src/Windows/Avalonia.Direct2D1/Direct2D1Platform.cs
@@ -181,6 +181,7 @@ public void Dispose()
 
             public IRenderTarget CreateRenderTarget(IEnumerable<object> surfaces) => _platform.CreateRenderTarget(surfaces);
             public bool IsLost => false;
+            public IReadOnlyDictionary<Type, object> PublicFeatures { get; } = new Dictionary<Type, object>();
         }
 
         public IPlatformRenderInterfaceContext CreateBackendContext(IPlatformGraphicsContext graphicsContext) =>

diff --git a/src/Windows/Avalonia.Win32/Win32Platform.cs b/src/Windows/Avalonia.Win32/Win32Platform.cs
@@ -125,6 +125,7 @@ public static void Initialize(Win32PlatformOptions options)
                 AvaloniaLocator.CurrentMutable.Bind<IPlatformDragSource>().ToSingleton<DragSource>();
 
             s_compositor = new Compositor( platformGraphics);
+            AvaloniaLocator.CurrentMutable.Bind<Compositor>().ToConstant(s_compositor);
         }
 
         public event EventHandler<ShutdownRequestedEventArgs>? ShutdownRequested;

diff --git a/src/iOS/Avalonia.iOS/Platform.cs b/src/iOS/Avalonia.iOS/Platform.cs
@@ -49,6 +49,7 @@ public static void Register()
                 .Bind<IKeyboardDevice>().ToConstant(keyboard);
 
                 Compositor = new Compositor(AvaloniaLocator.Current.GetService<IPlatformGraphics>());
+            	AvaloniaLocator.CurrentMutable.Bind<Compositor>().ToConstant(Compositor);
         }
     }
 }