[#59] Added VMA to the context of the framework

Signed-off-by: Tobias Frisch <tfrisch@uni-koblenz.de>

.gitmodules

@@ -22,3 +22,6 @@
 [submodule "modules/gui/lib/imgui"]
 	path = modules/gui/lib/imgui
 	url = https://github.com/ocornut/imgui.git
+[submodule "lib/VulkanMemoryAllocator"]
+	path = lib/VulkanMemoryAllocator
+	url = https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator.git

config/Libraries.cmake

@@ -19,6 +19,7 @@ set(vkcv_config_msg " - Library: ")
 include(${vkcv_config_lib}/GLFW.cmake)    # glfw-x11 / glfw-wayland					# libglfw3-dev
 include(${vkcv_config_lib}/Vulkan.cmake)  # vulkan-intel / vulkan-radeon / nvidia	# libvulkan-dev
 include(${vkcv_config_lib}/SPIRV_Cross.cmake)  # SPIRV-Cross	                    # libspirv_cross_c_shared
+include(${vkcv_config_lib}/VulkanMemoryAllocator.cmake) # VulkanMemoryAllocator
 
 # cleanup of compiler flags
 if (vkcv_flags)

config/lib/GLFW.cmake

@@ -10,6 +10,7 @@ else()
         add_subdirectory(${vkcv_lib}/glfw)
 
         list(APPEND vkcv_libraries glfw)
+        list(APPEND vkcv_includes ${vkcv_lib}/glfw/include)
 
         message(${vkcv_config_msg} " GLFW    -   " ${glfw3_VERSION})
     else()

config/lib/SPIRV_Cross.cmake

@@ -25,6 +25,7 @@ else()
         add_subdirectory(${vkcv_lib}/SPIRV-Cross)
 
         list(APPEND vkcv_libraries spirv-cross-cpp)
+        list(APPEND vkcv_includes ${vkcv_lib}/SPIV-Cross/include)
 
         message(${vkcv_config_msg} " SPIRV Cross    - " ${SPIRV_CROSS_VERSION})
     else()

config/lib/VulkanMemoryAllocator.cmake

+
+if (EXISTS "${vkcv_lib_path}/VulkanMemoryAllocator")
+	add_subdirectory(${vkcv_lib}/VulkanMemoryAllocator)
+	
+	list(APPEND vkcv_libraries VulkanMemoryAllocator)
+	list(APPEND vkcv_includes ${vkcv_lib}/VulkanMemoryAllocator/include)
+	
+	message(${vkcv_config_msg} " VMA     - ")
+else()
+	message(WARNING "VulkanMemoryAllocator is required..! Update the submodules!")
+endif ()

include/vkcv/Context.hpp

 #pragma once
 
 #include <vulkan/vulkan.hpp>
+#include <vk_mem_alloc.h>
 
 #include "QueueManager.hpp"
 
@@ -32,6 +33,9 @@ namespace vkcv
         
         [[nodiscard]]
         const QueueManager& getQueueManager() const;
+	
+        [[nodiscard]]
+		const VmaAllocator& getAllocator() const;
         
         static Context create(const char *applicationName,
 							  uint32_t applicationVersion,
@@ -47,11 +51,14 @@ namespace vkcv
          * @param physicalDevice Vulkan-PhysicalDevice
          * @param device Vulkan-Device
          */
-        Context(vk::Instance instance, vk::PhysicalDevice physicalDevice, vk::Device device, QueueManager&& queueManager) noexcept;
+        Context(vk::Instance instance, vk::PhysicalDevice physicalDevice, vk::Device device,
+				QueueManager&& queueManager, VmaAllocator& allocator) noexcept;
         
         vk::Instance        m_Instance;
         vk::PhysicalDevice  m_PhysicalDevice;
         vk::Device          m_Device;
 		QueueManager		m_QueueManager;
+		VmaAllocator 		m_Allocator;
+		
     };
 }

VulkanMemoryAllocator @ 55868965

+Subproject commit 55868965ae1fa956c07695d4642e1add8c9450f7

src/vkcv/Context.cpp

@@ -9,11 +9,13 @@ namespace vkcv
             m_Instance(other.m_Instance),
             m_PhysicalDevice(other.m_PhysicalDevice),
             m_Device(other.m_Device),
-            m_QueueManager(other.m_QueueManager)
+            m_QueueManager(other.m_QueueManager),
+            m_Allocator(other.m_Allocator)
     {
         other.m_Instance        = nullptr;
         other.m_PhysicalDevice  = nullptr;
         other.m_Device          = nullptr;
+		other.m_Allocator		= nullptr;
     }
 
     Context & Context::operator=(Context &&other) noexcept
@@ -22,10 +24,12 @@ namespace vkcv
         m_PhysicalDevice    = other.m_PhysicalDevice;
         m_Device            = other.m_Device;
         m_QueueManager		= other.m_QueueManager;
+        m_Allocator			= other.m_Allocator;
 
         other.m_Instance        = nullptr;
         other.m_PhysicalDevice  = nullptr;
         other.m_Device          = nullptr;
+        other.m_Allocator		= nullptr;
 
         return *this;
     }
@@ -33,15 +37,21 @@ namespace vkcv
     Context::Context(vk::Instance instance,
                      vk::PhysicalDevice physicalDevice,
                      vk::Device device,
-					 QueueManager&& queueManager) noexcept :
-    m_Instance{instance},
-    m_PhysicalDevice{physicalDevice},
-    m_Device{device},
-    m_QueueManager{queueManager}
+					 QueueManager&& queueManager,
+					 VmaAllocator& allocator) noexcept :
+    m_Instance(instance),
+    m_PhysicalDevice(physicalDevice),
+    m_Device(device),
+    m_QueueManager(queueManager),
+    m_Allocator(allocator)
     {}
 
     Context::~Context() noexcept
     {
+    	if (m_Allocator) {
+			vmaDestroyAllocator(m_Allocator);
+    	}
+    	
         m_Device.destroy();
         m_Instance.destroy();
     }
@@ -64,6 +74,10 @@ namespace vkcv
     const QueueManager& Context::getQueueManager() const {
     	return m_QueueManager;
     }
+    
+    const VmaAllocator& Context::getAllocator() const {
+    	return m_Allocator;
+    }
 	
 	/**
 	 * @brief The physical device is evaluated by three categories:
@@ -290,9 +304,25 @@ namespace vkcv
 		
 		vk::Device device = physicalDevice.createDevice(deviceCreateInfo);
 		
-		QueueManager queueManager = QueueManager::create(device, queuePairsGraphics, queuePairsCompute, queuePairsTransfer);
+		QueueManager queueManager = QueueManager::create(
+				device,
+				queuePairsGraphics,
+				queuePairsCompute,
+				queuePairsTransfer
+		);
+		
+		VmaAllocatorCreateInfo allocatorCreateInfo = {};
+		allocatorCreateInfo.physicalDevice = physicalDevice;
+		allocatorCreateInfo.instance = instance;
+		allocatorCreateInfo.device = device;
+		allocatorCreateInfo.vulkanApiVersion = VK_HEADER_VERSION_COMPLETE;
+		
+		VmaAllocator allocator;
+		if (VK_SUCCESS != vmaCreateAllocator(&allocatorCreateInfo, &allocator)) {
+			allocator = nullptr;
+		}
 		
-		return Context(instance, physicalDevice, device, std::move(queueManager));
+		return Context(instance, physicalDevice, device, std::move(queueManager), allocator);
 	}
  
 }