Reimplement object lifetimes to fix orphan objects (GraphicsDevice)

* Expands and enhances documentation
* Minor cleanups

Author: Ethereal77

sources/engine/Stride.Graphics/Direct3D/DebugHelpers.Direct3D.cs

@@ -7,11 +7,11 @@
 using System.Diagnostics;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
-using System.Text;
 using Silk.NET.Core.Native;
 using Silk.NET.Direct3D11;
 using Silk.NET.Direct3D12;
 using Silk.NET.DXGI;
+using Stride.Core;
 
 namespace Stride.Graphics;
 
@@ -23,7 +23,7 @@ public static Guid* WKPDID_D3DDebugObjectName
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         get
         {
-            ReadOnlySpan<byte> data = new byte[] {
+            ReadOnlySpan<byte> data = [
                 0x22, 0x8C, 0x9B, 0x42,
                 0x88, 0x91,
                 0x0C, 0x4B,
@@ -35,7 +35,7 @@ public static Guid* WKPDID_D3DDebugObjectName
                 0x85,
                 0xC2,
                 0x00
-            };
+            ];
 
             Debug.Assert(data.Length == Unsafe.SizeOf<Guid>());
 
@@ -48,32 +48,31 @@ public static Guid* WKPDID_D3DDebugObjectName
     ///   in some graphics debuggers.
     /// </summary>
 #if STRIDE_GRAPHICS_API_DIRECT3D11
-    public static void SetDebugName(ID3D11DeviceChild* deviceChild, string name)
+    public static void SetDebugName(this ComPtr<ID3D11DeviceChild> deviceChild, string name, ICollectorHolder owningObject)
     {
-        var nameUtf8 = Encoding.UTF8.GetBytes(name);
+        var nameMemory = SilkMarshal.StringToMemory(name, NativeStringEncoding.LPWStr);
+        nameMemory.DisposeBy(owningObject);
 
-        deviceChild->SetPrivateData(WKPDID_D3DDebugObjectName, (uint) nameUtf8.Length, in nameUtf8[0]);
+        deviceChild.SetPrivateData(WKPDID_D3DDebugObjectName, (uint) nameMemory.Length, nameMemory.AsPtr<char>());
     }
 #elif STRIDE_GRAPHICS_API_DIRECT3D12
-    public static unsafe void SetDebugName(ID3D12DeviceChild* deviceChild, string name)
+    public static unsafe void SetDebugName(this ComPtr<ID3D12DeviceChild> deviceChild, string name)
     {
-        var ptrName = (char*) SilkMarshal.StringToPtr(name, NativeStringEncoding.LPWStr);
-
-        deviceChild->SetName(ptrName);
-
-        SilkMarshal.Free((nint) ptrName);
+        using var nameMemory = SilkMarshal.StringToMemory(name, NativeStringEncoding.LPWStr);
+        deviceChild->SetName(nameMemory.AsPtr<char>());
     }
 #endif
 
     /// <summary>
     ///   Associates a debug name to the private data of a DXGI object, useful to see a friendly name
     ///   in some graphics debuggers.
     /// </summary>
-    public static void SetDebugName(IDXGIObject* deviceChild, string name)
+    public static void SetDebugName(this ComPtr<IDXGIObject> dxgiObject, string name, ICollectorHolder owningObject)
     {
-        var nameUtf8 = Encoding.UTF8.GetBytes(name);
+        var nameMemory = SilkMarshal.StringToMemory(name, NativeStringEncoding.LPWStr);
+        nameMemory.DisposeBy(owningObject);
 
-        deviceChild->SetPrivateData(WKPDID_D3DDebugObjectName, (uint) nameUtf8.Length, in nameUtf8[0]);
+        dxgiObject.SetPrivateData(WKPDID_D3DDebugObjectName, (uint)nameMemory.Length, nameMemory.AsPtr<char>());
     }
 }
 

sources/engine/Stride.Graphics/Direct3D/GraphicsDevice.Direct3D.cs

@@ -12,6 +12,7 @@
 using Stride.Core;
 
 using QueryPtr = Stride.Core.UnsafeExtensions.Pointer<Silk.NET.Direct3D11.ID3D11Query>;
+using System.Runtime.CompilerServices;
 
 namespace Stride.Graphics
 {
@@ -27,15 +28,17 @@ public unsafe partial class GraphicsDevice
         /// <summary>
         ///   Gets the native Direct3D 11 device.
         /// </summary>
-        public ID3D11Device* NativeDevice { get; private set; }
+        public ComPtr<ID3D11Device> NativeDevice { get; private set; }
 
         /// <summary>
         ///   Gets the native Direct3D 11 device context.
         /// </summary>
-        internal ID3D11DeviceContext* NativeDeviceContext { get; private set; }
+        internal ComPtr<ID3D11DeviceContext> NativeDeviceContext { get; private set; }
 
-        private readonly Queue<QueryPtr> disjointQueries = new(4);
-        private readonly Stack<QueryPtr> currentDisjointQueries = new(2);
+        //private readonly Queue<QueryPtr> disjointQueries = new(4);
+        //private readonly Stack<QueryPtr> currentDisjointQueries = new(2);
+        private readonly Queue<ComPtr<ID3D11Query>> disjointQueries = new(4);
+        private readonly Stack<ComPtr<ID3D11Query>> currentDisjointQueries = new(2);
 
         internal GraphicsProfile RequestedProfile;
 
@@ -45,7 +48,7 @@ public unsafe partial class GraphicsDevice
         /// <summary>
         /// The tick frquency of timestamp queries in Hertz.
         /// </summary>
-        public long TimestampFrequency { get; private set; }
+        public ulong TimestampFrequency { get; private set; }
 
         /// <summary>
         ///   Gets the current status of this device.
@@ -60,7 +63,7 @@ public GraphicsDeviceStatus GraphicsDeviceStatus
                     return GraphicsDeviceStatus.Reset;
                 }
 
-                var result = (DeviceRemoveReason) NativeDevice->GetDeviceRemovedReason();
+                var result = (DeviceRemoveReason) NativeDevice.GetDeviceRemovedReason();
 
                 return result switch
                 {
@@ -95,52 +98,50 @@ private enum DeviceRemoveReason : int
         /// <summary>
         ///   Marks the graphics device context as active on the current thread.
         /// </summary>
-        public unsafe void Begin()
+        public void Begin()
         {
             FrameTriangleCount = 0;
             FrameDrawCalls = 0;
 
-            var queryResult = new QueryDataTimestampDisjoint();
+            Unsafe.SkipInit(out QueryDataTimestampDisjoint queryResult);
 
-            ID3D11Query* currentDisjointQuery = null;
+            ComPtr<ID3D11Query> currentDisjointQuery = null;
 
             // Try to read back the oldest disjoint query and reuse it. If not ready, create a new one
             if (disjointQueries.Count > 0)
             {
                 currentDisjointQuery = disjointQueries.Peek();
 
-                var asyncQuery = (ID3D11Asynchronous*) currentDisjointQuery;
-                var dataSize = currentDisjointQuery->GetDataSize();
-                HResult result = NativeDeviceContext->GetData(asyncQuery, ref queryResult, dataSize, (int) AsyncGetdataFlag.Donotflush);
+                var asyncQuery = (ID3D11Asynchronous*) currentDisjointQuery.Handle;
+                var dataSize = currentDisjointQuery.GetDataSize();
+                HResult result = NativeDeviceContext.GetData(asyncQuery, ref queryResult, dataSize, (int) AsyncGetdataFlag.Donotflush);
 
                 if (result.IsFailure)
                     result.Throw();
 
-                TimestampFrequency = (long) queryResult.Frequency;
+                TimestampFrequency = queryResult.Frequency;
                 currentDisjointQuery = disjointQueries.Dequeue();
             }
             else
             {
                 var disjointQueryDescription = new QueryDesc { Query = Query.TimestampDisjoint };
 
-                HResult result = NativeDevice->CreateQuery(in disjointQueryDescription, ref currentDisjointQuery);
+                HResult result = NativeDevice.CreateQuery(in disjointQueryDescription, ref currentDisjointQuery);
 
                 if (result.IsFailure)
                     result.Throw();
             }
 
             currentDisjointQueries.Push(currentDisjointQuery);
 
-            NativeDeviceContext->Begin((ID3D11Asynchronous*) currentDisjointQuery);
+            NativeDeviceContext.Begin(currentDisjointQuery);
         }
 
         /// <summary>
-        /// Enables profiling.
+        ///   Enables or disables profiling.
         /// </summary>
-        /// <param name="enabledFlag">if set to <c>true</c> [enabled flag].</param>
-        public void EnableProfile(bool enabledFlag)
-        {
-        }
+        /// <param name="enabledFlag"><see langword="true"/> to enable profiling; <see langword="false"/> to disable it.</param>
+        public void EnableProfile(bool enabledFlag) { }
 
         /// <summary>
         ///   Unmarks the graphics device context as active on the current thread.
@@ -149,34 +150,31 @@ public unsafe void End()
         {
             // If this fails, it means Begin() / End() don't match, something is very wrong
             var currentDisjointQuery = currentDisjointQueries.Pop();
-
-            ID3D11Asynchronous* asyncQuery = null;
-
-            ID3D11Query* query = currentDisjointQuery;
-            query->QueryInterface(SilkMarshal.GuidPtrOf<ID3D11Asynchronous>(), (void**) &asyncQuery);
-
-            NativeDeviceContext->End(asyncQuery);
+            NativeDeviceContext.End(currentDisjointQuery);
             disjointQueries.Enqueue(currentDisjointQuery);
         }
 
         /// <summary>
-        /// Executes a deferred command list.
+        ///   Executes a deferred command list.
         /// </summary>
-        /// <param name="commandList">The deferred command list.</param>
+        /// <param name="commandList">The deferred command list to execute.</param>
         public void ExecuteCommandList(CompiledCommandList commandList)
         {
             throw new NotImplementedException();
         }
 
         /// <summary>
-        /// Executes multiple deferred command lists.
+        ///   Executes multiple deferred command lists.
         /// </summary>
-        /// <param name="commandLists">The deferred command lists.</param>
+        /// <param name="commandLists">The deferred command lists to execute.</param>
         public void ExecuteCommandLists(int count, CompiledCommandList[] commandLists)
         {
             throw new NotImplementedException();
         }
 
+        /// <summary>
+        ///   Sets the graphics device to simulate a situation in which the device is lost and then reset.
+        /// </summary>
         public void SimulateReset()
         {
             simulateReset = true;
@@ -194,14 +192,14 @@ private string GetRendererName()
         }
 
         /// <summary>
-        ///     Initializes the specified device.
+        ///   Initializes the graphics device.
         /// </summary>
-        /// <param name="graphicsProfiles">The graphics profiles.</param>
+        /// <param name="graphicsProfiles">The graphics profiles to try, in order of preference.</param>
         /// <param name="deviceCreationFlags">The device creation flags.</param>
         /// <param name="windowHandle">The window handle.</param>
         private unsafe void InitializePlatformDevice(GraphicsProfile[] graphicsProfiles, DeviceCreationFlags deviceCreationFlags, object windowHandle)
         {
-            if (NativeDevice != null)
+            if (NativeDevice.Handle != null)
             {
                 // Destroy previous device
                 ReleaseDevice();
@@ -212,14 +210,13 @@ private unsafe void InitializePlatformDevice(GraphicsProfile[] graphicsProfiles,
             // Profiling is supported through PIX markers
             IsProfilingSupported = true;
 
-            // Map GraphicsProfile to D3D11 FeatureLevel
             creationFlags = (CreateDeviceFlag) deviceCreationFlags;
 
-            // Create Device D3D11 with feature Level based on profile
+            // Create D3D11 Device with feature Level based on profile
             for (int index = 0; index < graphicsProfiles.Length; index++)
             {
+                // Map GraphicsProfiles to D3D11 FeatureLevels
                 var graphicsProfile = graphicsProfiles[index];
-
                 var level = graphicsProfile.ToFeatureLevel();
 
                 // INTEL workaround: it seems Intel driver doesn't support properly feature level 9.x. Fallback to 10.
@@ -254,8 +251,8 @@ private unsafe void InitializePlatformDevice(GraphicsProfile[] graphicsProfiles,
                         continue;
                 }
 
-                NativeDevice = device;
-                NativeDeviceContext = deviceContext;
+                NativeDevice = new ComPtr<ID3D11Device> { Handle = device }.DisposeBy(this);
+                NativeDeviceContext = new ComPtr<ID3D11DeviceContext> { Handle = deviceContext }.DisposeBy(this);
 
                 // INTEL workaround: force ShaderProfile to be 10+ as well
                 if (Adapter.VendorId == 0x8086)
@@ -272,53 +269,68 @@ private unsafe void InitializePlatformDevice(GraphicsProfile[] graphicsProfiles,
             //((IUnknown)nativeDeviceContext).AddReference();
             if (IsDebugMode)
             {
-                DebugHelpers.SetDebugName((ID3D11DeviceChild*) NativeDeviceContext, "ImmediateContext");
+                using ComPtr<ID3D11DeviceChild> deviceChild = NativeDeviceContext.QueryInterface<ID3D11DeviceChild>();
+                deviceChild.SetDebugName("ImmediateContext", owningObject: this);
             }
         }
 
+        /// <summary>
+        ///   Makes adjustments to the pipeline state specific to Direct3D 11.
+        /// </summary>
+        /// <param name="pipelineStateDescription">The pipeline state description to modify.</param>
         private void AdjustDefaultPipelineStateDescription(ref PipelineStateDescription pipelineStateDescription)
         {
             // On D3D, default state is Less instead of our LessEqual
             // Let's update default pipeline state so that it correspond to D3D state after a "ClearState()"
             pipelineStateDescription.DepthStencilState.DepthBufferFunction = CompareFunction.Less;
         }
 
+        /// <summary>
+        ///   Releases the graphics device and all its associated resources.
+        /// </summary>
         protected void DestroyPlatformDevice()
         {
             ReleaseDevice();
         }
 
+        /// <summary>
+        ///   Disposes the graphics device and all its associated resources.
+        /// </summary>
         private void ReleaseDevice()
         {
             foreach (var queryPtr in disjointQueries)
             {
-                queryPtr.Value->Release();
+                queryPtr.Release();
             }
             disjointQueries.Clear();
 
-            // Display D3D11 ref counting info
             ID3D11DeviceContext* immediateContext = null;
-            NativeDevice->GetImmediateContext(ref immediateContext);
+            NativeDevice.GetImmediateContext(ref immediateContext);
 
             immediateContext->ClearState();
             immediateContext->Flush();
+            immediateContext->Release();
 
+            // Display D3D11 ref counting info
             if (IsDebugMode)
             {
-                ID3D11Debug* debugDevice = null;
-                HResult result = NativeDevice->QueryInterface(SilkMarshal.GuidPtrOf<ID3D11Debug>(), (void**) &debugDevice);
+                HResult result = NativeDevice.QueryInterface(out ComPtr<ID3D11Debug> debugDevice);
 
-                if (result.IsSuccess && debugDevice != null)
+                if (result.IsSuccess && debugDevice.Handle != null)
                 {
-                    debugDevice->ReportLiveDeviceObjects(RldoFlags.Detail);
-                    debugDevice->Release();
+                    debugDevice.ReportLiveDeviceObjects(RldoFlags.Detail);
+                    debugDevice.Release();
                 }
             }
 
-            NativeDevice->Release();
+            NativeDevice.RemoveDisposeBy(this);
+            NativeDevice.Dispose();
             NativeDevice = null;
         }
 
+        /// <summary>
+        ///   Called when the graphics device is being destroyed.
+        /// </summary>
         internal void OnDestroyed()
         {
         }

sources/engine/Stride.Graphics/Direct3D12/GraphicsDevice.Direct3D12.cs

@@ -73,7 +73,7 @@ public unsafe partial class GraphicsDevice
         /// <summary>
         /// The tick frquency of timestamp queries in Hertz.
         /// </summary>
-        public ulong TimestampFrequency { get; private set; }
+        public long TimestampFrequency { get; private set; }
 
         /// <summary>
         ///     Gets the status of this device.
@@ -137,9 +137,9 @@ public void Begin()
         }
 
         /// <summary>
-        /// Enables profiling.
+        ///   Enables or disables profiling.
         /// </summary>
-        /// <param name="enabledFlag">if set to <c>true</c> [enabled flag].</param>
+        /// <param name="enabledFlag"><see langword="true"/> to enable profiling; <see langword="false"/> to disable it.</param>
         public void EnableProfile(bool enabledFlag)
         {
         }