Enhanced vulkan triangle app (#475)

* Start of enhanced vulkan triangle app

* Ignore debug messages in the validation layer, because they produce too much output

* Fix validation error which was caused by creating device queues with the same index more than once

* Resizing of the window is working now; caching values in two places needed to be disabled otherwise the cached values are out of date and don't allow for successful resize

* Enable rendering while resizing

* Added a switch to allow event based rendering; if no inputs are received at all no new images will be rendered

* Use var in foreach for variable type

Author: hjred

src/Lab/VulkanTriangle/HelloTriangleApplication.cs

@@ -10,6 +10,7 @@
 using System.Runtime.InteropServices;
 using Silk.NET.Core;
 using Silk.NET.Core.Native;
+using Silk.NET.Maths;
 using Silk.NET.Vulkan;
 using Silk.NET.Vulkan.Extensions.EXT;
 using Silk.NET.Vulkan.Extensions.KHR;
@@ -22,6 +23,7 @@ public class HelloTriangleApplication
     {
         public const bool EnableValidationLayers = true;
         public const int MaxFramesInFlight = 8;
+        public const bool EventBasedRendering = false;
 
         public void Run()
         {
@@ -63,6 +65,8 @@ public void Run()
         private Fence[] _imagesInFlight;
         private uint _currentFrame;
 
+        private bool _framebufferResized = false;
+
         private Vk _vk;
         private KhrSurface _vkSurface;
         private KhrSwapchain _vkSwapchain;
@@ -74,13 +78,22 @@ public void Run()
         private void InitWindow()
         {
             var opts = WindowOptions.DefaultVulkan;
+            opts.IsEventDriven = EventBasedRendering;
             _window = Window.Create(opts);
             if (_window?.VkSurface is null)
             {
                 throw new NotSupportedException("Windowing platform doesn't support Vulkan.");
             }
 
             _window.Initialize();
+            _window.FramebufferResize += OnFramebufferResize;
+        }
+
+        private void OnFramebufferResize(Vector2D<int> size)
+        {
+            _framebufferResized = true;
+            RecreateSwapChain();
+            _window.DoRender();
         }
 
         private void InitVulkan()
@@ -113,9 +126,19 @@ private unsafe void DrawFrame(double obj)
             _vk.WaitForFences(_device, 1, in fence, Vk.True, ulong.MaxValue);
 
             uint imageIndex;
-            _vkSwapchain.AcquireNextImage
+            Result result =_vkSwapchain.AcquireNextImage
                 (_device, _swapchain, ulong.MaxValue, _imageAvailableSemaphores[_currentFrame], default, &imageIndex);
 
+            if (result == Result.ErrorOutOfDateKhr)
+            {
+                RecreateSwapChain();
+                return;
+            }
+            else if (result != Result.Success && result != Result.SuboptimalKhr)
+            {
+                throw new Exception("failed to acquire swap chain image!");
+            }
+
             if (_imagesInFlight[imageIndex].Handle != 0)
             {
                 _vk.WaitForFences(_device, 1, in _imagesInFlight[imageIndex], Vk.True, ulong.MaxValue);
@@ -165,14 +188,26 @@ private unsafe void DrawFrame(double obj)
                     PImageIndices = &imageIndex
                 };
 
-                _vkSwapchain.QueuePresent(_presentQueue, &presentInfo);
+                result = _vkSwapchain.QueuePresent(_presentQueue, &presentInfo);
+            }
+
+            if (result == Result.ErrorOutOfDateKhr || result == Result.SuboptimalKhr || _framebufferResized)
+            {
+                _framebufferResized = false;
+                RecreateSwapChain();
+            }
+            else if (result != Result.Success)
+            {
+                throw new Exception("failed to present swap chain image!");
             }
 
             _currentFrame = (_currentFrame + 1) % MaxFramesInFlight;
         }
 
         private unsafe void Cleanup()
         {
+            CleanupSwapchain();
+
             for (var i = 0; i < MaxFramesInFlight; i++)
             {
                 _vk.DestroySemaphore(_device, _renderFinishedSemaphores[i], null);
@@ -182,11 +217,29 @@ private unsafe void Cleanup()
 
             _vk.DestroyCommandPool(_device, _commandPool, null);
 
+            _vk.DestroyDevice(_device, null);
+
+            if (EnableValidationLayers)
+            {
+                _debugUtils.DestroyDebugUtilsMessenger(_instance, _debugMessenger, null);
+            }
+
+            _vkSurface.DestroySurface(_instance, _surface, null);
+            _vk.DestroyInstance(_instance, null);
+        }
+
+        private unsafe void CleanupSwapchain()
+        {
             foreach (var framebuffer in _swapchainFramebuffers)
             {
                 _vk.DestroyFramebuffer(_device, framebuffer, null);
             }
 
+            fixed (CommandBuffer* buffers = _commandBuffers)
+            {
+                _vk.FreeCommandBuffers(_device, _commandPool, (uint) _commandBuffers.Length, buffers);
+            }
+
             _vk.DestroyPipeline(_device, _graphicsPipeline, null);
             _vk.DestroyPipelineLayout(_device, _pipelineLayout, null);
             _vk.DestroyRenderPass(_device, _renderPass, null);
@@ -197,15 +250,6 @@ private unsafe void Cleanup()
             }
 
             _vkSwapchain.DestroySwapchain(_device, _swapchain, null);
-            _vk.DestroyDevice(_device, null);
-
-            if (EnableValidationLayers)
-            {
-                _debugUtils.DestroyDebugUtilsMessenger(_instance, _debugMessenger, null);
-            }
-
-            _vkSurface.DestroySurface(_instance, _surface, null);
-            _vk.DestroyInstance(_instance, null);
         }
 
         private unsafe void CreateInstance()
@@ -324,8 +368,13 @@ private unsafe uint DebugCallback
             void* pUserData
         )
         {
-            Console.WriteLine
-                ($"{messageSeverity} {messageTypes}" + Marshal.PtrToStringAnsi((nint) pCallbackData->PMessage));
+            if (messageSeverity > DebugUtilsMessageSeverityFlagsEXT.DebugUtilsMessageSeverityVerboseBitExt)
+            {
+                Console.WriteLine
+                    ($"{messageSeverity} {messageTypes}" + Marshal.PtrToStringAnsi((nint) pCallbackData->PMessage));
+
+            }
+
             return Vk.False;
         }
 
@@ -363,101 +412,93 @@ private unsafe void PickPhysicalDevice()
                 throw new Exception("No suitable device.");
         }
 
-        private static readonly ConcurrentDictionary<PhysicalDevice, SwapChainSupportDetails> _swapChainSupportDetailsCache
-            = new ConcurrentDictionary<PhysicalDevice, SwapChainSupportDetails>();
+        // Caching the returned values breaks the ability for resizing the window
         private unsafe SwapChainSupportDetails QuerySwapChainSupport(PhysicalDevice device)
         {
-            return _swapChainSupportDetailsCache.GetOrAdd(device, d =>
-            {
-                var details = new SwapChainSupportDetails();
-                _vkSurface.GetPhysicalDeviceSurfaceCapabilities(d, _surface, out var surfaceCapabilities);
-                details.Capabilities = surfaceCapabilities;
+            var details = new SwapChainSupportDetails();
+            _vkSurface.GetPhysicalDeviceSurfaceCapabilities(device, _surface, out var surfaceCapabilities);
+            details.Capabilities = surfaceCapabilities;
 
-                var formatCount = 0u;
-                _vkSurface.GetPhysicalDeviceSurfaceFormats(d, _surface, &formatCount, null);
+            var formatCount = 0u;
+            _vkSurface.GetPhysicalDeviceSurfaceFormats(device, _surface, &formatCount, null);
 
-                if (formatCount != 0)
-                {
-                    details.Formats = new SurfaceFormatKHR[formatCount];
+            if (formatCount != 0)
+            {
+                details.Formats = new SurfaceFormatKHR[formatCount];
 
-                    using var mem = GlobalMemory.Allocate((int) formatCount * sizeof(SurfaceFormatKHR));
-                    var formats = (SurfaceFormatKHR*) Unsafe.AsPointer(ref mem.GetPinnableReference());
+                using var mem = GlobalMemory.Allocate((int) formatCount * sizeof(SurfaceFormatKHR));
+                var formats = (SurfaceFormatKHR*) Unsafe.AsPointer(ref mem.GetPinnableReference());
 
-                    _vkSurface.GetPhysicalDeviceSurfaceFormats(d, _surface, &formatCount, formats);
+                _vkSurface.GetPhysicalDeviceSurfaceFormats(device, _surface, &formatCount, formats);
 
-                    for (var i = 0; i < formatCount; i++)
-                    {
-                        details.Formats[i] = formats[i];
-                    }
+                for (var i = 0; i < formatCount; i++)
+                {
+                    details.Formats[i] = formats[i];
                 }
+            }
 
-                var presentModeCount = 0u;
-                _vkSurface.GetPhysicalDeviceSurfacePresentModes(d, _surface, &presentModeCount, null);
+            var presentModeCount = 0u;
+            _vkSurface.GetPhysicalDeviceSurfacePresentModes(device, _surface, &presentModeCount, null);
 
-                if (presentModeCount != 0)
-                {
-                    details.PresentModes = new PresentModeKHR[presentModeCount];
+            if (presentModeCount != 0)
+            {
+                details.PresentModes = new PresentModeKHR[presentModeCount];
 
-                    using var mem = GlobalMemory.Allocate((int) presentModeCount * sizeof(PresentModeKHR));
-                    var modes = (PresentModeKHR*) Unsafe.AsPointer(ref mem.GetPinnableReference());
+                using var mem = GlobalMemory.Allocate((int) presentModeCount * sizeof(PresentModeKHR));
+                var modes = (PresentModeKHR*) Unsafe.AsPointer(ref mem.GetPinnableReference());
 
-                    _vkSurface.GetPhysicalDeviceSurfacePresentModes(d, _surface, &presentModeCount, modes);
+                _vkSurface.GetPhysicalDeviceSurfacePresentModes(device, _surface, &presentModeCount, modes);
 
-                    for (var i = 0; i < presentModeCount; i++)
-                    {
-                        details.PresentModes[i] = modes[i];
-                    }
+                for (var i = 0; i < presentModeCount; i++)
+                {
+                    details.PresentModes[i] = modes[i];
                 }
+            }
 
-                return details;
-            });
+            return details;
         }
 
         private unsafe bool CheckDeviceExtensionSupport(PhysicalDevice device)
         {
             return _deviceExtensions.All(ext => _vk.IsDeviceExtensionPresent(device, ext));
         }
 
-        private static readonly ConcurrentDictionary<PhysicalDevice, QueueFamilyIndices> _queueFamilyIndicesCache
-            = new ConcurrentDictionary<PhysicalDevice, QueueFamilyIndices>();
+        // Caching these values might have unintended side effects
         private unsafe QueueFamilyIndices FindQueueFamilies(PhysicalDevice device)
         {
-            return _queueFamilyIndicesCache.GetOrAdd(device, d =>
-            {
-                var indices = new QueueFamilyIndices();
+            var indices = new QueueFamilyIndices();
 
-                uint queryFamilyCount = 0;
-                _vk.GetPhysicalDeviceQueueFamilyProperties(d, &queryFamilyCount, null);
+            uint queryFamilyCount = 0;
+            _vk.GetPhysicalDeviceQueueFamilyProperties(device, &queryFamilyCount, null);
 
-                using var mem = GlobalMemory.Allocate((int) queryFamilyCount * sizeof(QueueFamilyProperties));
-                var queueFamilies = (QueueFamilyProperties*) Unsafe.AsPointer(ref mem.GetPinnableReference());
+            using var mem = GlobalMemory.Allocate((int) queryFamilyCount * sizeof(QueueFamilyProperties));
+            var queueFamilies = (QueueFamilyProperties*) Unsafe.AsPointer(ref mem.GetPinnableReference());
 
-                _vk.GetPhysicalDeviceQueueFamilyProperties(d, &queryFamilyCount, queueFamilies);
-                for (var i = 0u; i < queryFamilyCount; i++)
+            _vk.GetPhysicalDeviceQueueFamilyProperties(device, &queryFamilyCount, queueFamilies);
+            for (var i = 0u; i < queryFamilyCount; i++)
+            {
+                var queueFamily = queueFamilies[i];
+                // note: HasFlag is slow on .NET Core 2.1 and below.
+                // if you're targeting these versions, use ((queueFamily.QueueFlags & QueueFlags.QueueGraphicsBit) != 0)
+                if (queueFamily.QueueFlags.HasFlag(QueueFlags.QueueGraphicsBit))
                 {
-                    var queueFamily = queueFamilies[i];
-                    // note: HasFlag is slow on .NET Core 2.1 and below.
-                    // if you're targeting these versions, use ((queueFamily.QueueFlags & QueueFlags.QueueGraphicsBit) != 0)
-                    if (queueFamily.QueueFlags.HasFlag(QueueFlags.QueueGraphicsBit))
-                    {
-                        indices.GraphicsFamily = i;
-                    }
+                    indices.GraphicsFamily = i;
+                }
 
-                    _vkSurface.GetPhysicalDeviceSurfaceSupport(d, i, _surface, out var presentSupport);
+                _vkSurface.GetPhysicalDeviceSurfaceSupport(device, i, _surface, out var presentSupport);
 
-                    if (presentSupport == Vk.True)
-                    {
-                        indices.PresentFamily = i;
-                    }
+                if (presentSupport == Vk.True)
+                {
+                    indices.PresentFamily = i;
+                }
 
-                    if (indices.IsComplete())
-                    {
-                        break;
-                    }
+                if (indices.IsComplete())
+                {
+                    break;
                 }
+            }
 
-                return indices;
-            });
+            return indices;
         }
 
         public struct QueueFamilyIndices
@@ -481,7 +522,9 @@ public struct SwapChainSupportDetails
         private unsafe void CreateLogicalDevice()
         {
             var indices = FindQueueFamilies(_physicalDevice);
-            var uniqueQueueFamilies = new[] { indices.GraphicsFamily.Value, indices.PresentFamily.Value };
+            var uniqueQueueFamilies = indices.GraphicsFamily.Value == indices.PresentFamily.Value
+                ? new[] { indices.GraphicsFamily.Value }
+                : new[] { indices.GraphicsFamily.Value, indices.PresentFamily.Value };
 
             using var mem = GlobalMemory.Allocate((int) uniqueQueueFamilies.Length * sizeof(DeviceQueueCreateInfo));
             var queueCreateInfos = (DeviceQueueCreateInfo*) Unsafe.AsPointer(ref mem.GetPinnableReference());
@@ -624,6 +667,30 @@ private unsafe void CreateSwapChain()
             _swapchainExtent = extent;
         }
 
+        private unsafe void RecreateSwapChain()
+        {
+            Vector2D<int> framebufferSize = _window.FramebufferSize;
+
+            while (framebufferSize.X == 0 || framebufferSize.Y == 0)
+            {
+                framebufferSize = _window.FramebufferSize;
+                _window.DoEvents();
+            }
+
+            _ = _vk.DeviceWaitIdle(_device);
+
+            CleanupSwapchain();
+
+            CreateSwapChain();
+            CreateImageViews();
+            CreateRenderPass();
+            CreateGraphicsPipeline();
+            CreateFramebuffers();
+            CreateCommandBuffers();
+
+            _imagesInFlight = new Fence[_swapchainImages.Length];
+        }
+
         private Extent2D ChooseSwapExtent(SurfaceCapabilitiesKHR capabilities)
         {
             if (capabilities.CurrentExtent.Width != uint.MaxValue)
@@ -632,7 +699,7 @@ private Extent2D ChooseSwapExtent(SurfaceCapabilitiesKHR capabilities)
             }
 
             var actualExtent = new Extent2D
-            { Height = (uint) _window.Size.Y, Width = (uint) _window.Size.X };
+            { Height = (uint) _window.FramebufferSize.Y, Width = (uint) _window.FramebufferSize.X };
             actualExtent.Width = new[]
             {
                 capabilities.MinImageExtent.Width,