[Graphics] Added function to help track down resource leaks.

Tape-Worm · Jan 12, 2022 · 7ef3cc8 · 7ef3cc8
1 parent cf83e36
commit 7ef3cc8
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 0 deletions.
diff --git a/Examples/Gorgon.Renderers.2D/Balls/Program.cs b/Examples/Gorgon.Renderers.2D/Balls/Program.cs
@@ -715,6 +715,9 @@ static void Main()
 		{
 			try
 			{
+				GorgonGraphics.IsObjectTrackingEnabled = true;
+				GorgonGraphics.IsDebugEnabled = true;
+
 				Application.SetHighDpiMode(HighDpiMode.PerMonitorV2);
 				Application.EnableVisualStyles();
 				Application.SetCompatibleTextRenderingDefault(false);

diff --git a/Gorgon/Gorgon.Graphics.Core/GorgonGraphics.cs b/Gorgon/Gorgon.Graphics.Core/GorgonGraphics.cs
@@ -27,6 +27,7 @@
 using System;
 using System.Collections.Generic;
 using System.ComponentModel;
+using System.Diagnostics;
 using System.Runtime.CompilerServices;
 using System.Threading;
 using Gorgon.Core;
@@ -590,6 +591,16 @@ private void SetDrawStates(D3DState state, in GorgonColor factor, int blendSampl
             _stateApplicator.BindResourceState(resourceChanges, state);
         }
 
+        /// <summary>
+        /// Function to report any objects that are left alive at the end of a session.
+        /// </summary>
+        private void ReportLiveObjectsInternal(D3D11.Device device)
+        {
+            using D3D11.DeviceDebug debugDevice = new(device);
+            debugDevice.ReportLiveDeviceObjects(D3D11.ReportingLevel.IgnoreInternal);
+        }
+
+
         /// <summary>
         /// Function to check for the minimum windows 10 build that Gorgon Graphics supports.
         /// </summary>
@@ -1223,6 +1234,24 @@ public void SubmitIndirect(GorgonInstancedCall drawCall, GorgonBuffer indirectAr
             }
         }
 
+        /// <summary>
+        /// Function to report internal objects that are still alive to the debug output.
+        /// </summary>
+        /// <remarks>
+        /// <para>
+        /// This method is used to track any object that is still alive even when they should be deactivated. Typically one would call this at shut down due to resource leaks noted by the debug runtime.
+        /// </para>
+        /// </remarks>
+        public void ReportLiveObjects()
+        {
+            if ((!IsObjectTrackingEnabled) || (!IsDebugEnabled) || (D3DDevice is null))
+            {
+                return;
+            }
+
+            ReportLiveObjectsInternal(D3DDevice);
+        }
+
         /// <summary>
         /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
         /// </summary>
@@ -1261,6 +1290,15 @@ public void Dispose()
             // Reset the state for the context. This will ensure we don't have anything bound to the pipeline when we shut down.
             context?.ClearState();
             context?.Dispose();
+
+#if DEBUG
+            if ((IsObjectTrackingEnabled) && (IsDebugEnabled))
+            {
+                Debug.WriteLine("GORGON: A live device object is normal, and will be destroyed after this report.");
+                ReportLiveObjectsInternal(device);
+            }
+#endif
+
             device?.Dispose();
             adapter?.Dispose();
             factory?.Dispose();