Added a dedicated buffer object class

base/vulkanbuffer.hpp

@@ -0,0 +1,148 @@
+/*
+* Vulkan buffer class
+*
+* Encapsulates a Vulkan buffer
+*
+* Copyright (C) 2016 by Sascha Willems - www.saschawillems.de
+*
+* This code is licensed under the MIT license (MIT) (http://opensource.org/licenses/MIT)
+*/
+
+#pragma once
+
+#include <vector>
+
+#include "vulkan/vulkan.h"
+#include "vulkantools.h"
+
+namespace vk
+{	
+	/**
+	* @brief Encapsulates access to a Vulkan buffer backed up by device memory
+	* @note To be filled by an external source like the VulkanDevice
+	*/
+	struct Buffer
+	{
+		VkBuffer buffer;
+		VkDevice device;
+		VkDeviceMemory memory;
+		VkDescriptorBufferInfo descriptor;
+		VkDeviceSize size = 0;
+		VkDeviceSize alignment = 0;
+		void* mapped = nullptr;
+
+		/** @brief Usage flags to be filled by external source at buffer creation (to query at some later point) */
+		VkBufferUsageFlags usageFlags;
+		/** @brief Memory propertys flags to be filled by external source at buffer creation (to query at some later point) */
+		VkMemoryPropertyFlags memoryPropertyFlags;
+
+		/** 
+		* Map a memory range of this buffer. If successful, mapped points to the specified buffer range.
+		* 
+		* @param size (Optional) Size of the memory range to map. Pass VK_WHOLE_SIZE to map the complete buffer range.
+		* @param offset (Optional) Byte offset from beginning
+		* 
+		* @return VkResult of the buffer mapping call
+		*/
+		VkResult map(VkDeviceSize size = VK_WHOLE_SIZE, VkDeviceSize offset = 0)
+		{
+			return vkMapMemory(device, memory, offset, size, 0, &mapped);
+		}
+
+		/**
+		* Unmap a mapped memory range
+		*
+		* @note Does not return a result as vkUnmapMemory can't fail
+		*/
+		void unmap()
+		{
+			if (mapped)
+			{
+				vkUnmapMemory(device, memory);
+				mapped = nullptr;
+			}
+		}
+
+		/** 
+		* Attach the allocated memory block to the buffer
+		* 
+		* @param offset (Optional) Byte offset (from the beginning) for the memory region to bind
+		* 
+		* @return VkResult of the bindBufferMemory call
+		*/
+		VkResult bind(VkDeviceSize offset = 0)
+		{
+			return vkBindBufferMemory(device, buffer, memory, offset);
+		}
+
+		/**
+		* Setup the default descriptor for this buffer
+		*
+		* @param size (Optional) Size of the memory range of the descriptor
+		* @param offset (Optional) Byte offset from beginning
+		*
+		*/
+		void setupDescriptor(VkDeviceSize size = VK_WHOLE_SIZE, VkDeviceSize offset = 0)
+		{
+			descriptor.offset = offset;
+			descriptor.buffer = buffer;
+			descriptor.range = size;
+		}
+
+		/** 
+		* Flush a memory range of the buffer to make it visible to the device
+		*
+		* @note Only required for non-coherent memory
+		*
+		* @param size (Optional) Size of the memory range to flush. Pass VK_WHOLE_SIZE to flush the complete buffer range.
+		* @param offset (Optional) Byte offset from beginning
+		*
+		* @return VkResult of the flush call
+		*/
+		VkResult flush(VkDeviceSize size = VK_WHOLE_SIZE, VkDeviceSize offset = 0)
+		{
+			VkMappedMemoryRange mappedRange = {};
+			mappedRange.sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
+			mappedRange.memory = memory;
+			mappedRange.offset = offset;
+			mappedRange.size = size;
+			return vkFlushMappedMemoryRanges(device, 1, &mappedRange);
+		}
+
+		/**
+		* Invalidate a memory range of the buffer to make it visible to the host
+		*
+		* @note Only required for non-coherent memory
+		*
+		* @param size (Optional) Size of the memory range to invalidate. Pass VK_WHOLE_SIZE to invalidate the complete buffer range.
+		* @param offset (Optional) Byte offset from beginning
+		*
+		* @return VkResult of the invalidate call
+		*/
+		VkResult invalidate(VkDeviceSize size = VK_WHOLE_SIZE, VkDeviceSize offset = 0)
+		{
+			VkMappedMemoryRange mappedRange = {};
+			mappedRange.sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
+			mappedRange.memory = memory;
+			mappedRange.offset = offset;
+			mappedRange.size = size;
+			return vkInvalidateMappedMemoryRanges(device, 1, &mappedRange);
+		}
+
+		/** 
+		* Release all Vulkan resources held by this buffer
+		*/
+		void destroy()
+		{
+			if (buffer)
+			{
+				vkDestroyBuffer(device, buffer, nullptr);
+			}
+			if (memory)
+			{
+				vkFreeMemory(device, memory, nullptr);
+			}
+		}
+
+	};
+}