MemoryAllocatorVulkan.h

#pragma once
 
#include <Foundation/Types/Bitflags.h>
#include <RendererVulkan/RendererVulkanDLL.h>
 
#include <vulkan/vulkan.hpp>
 
struct plVulkanAllocationCreateFlags
{
  typedef plUInt32 StorageType;
  enum Enum
  {
    DedicatedMemory = 0x00000001,
    NeverAllocate = 0x00000002,
    Mapped = 0x00000004,
    CanAlias = 0x00000200,
    HostAccessSequentialWrite = 0x00000400,
    HostAccessRandom = 0x00000800,
    StrategyMinMemory = 0x00010000,
    StrategyMinTime = 0x00020000,
    Default = 0,
  };
 
  struct Bits
  {
    StorageType DedicatedMemory : 1;
    StorageType NeverAllocate : 1;
    StorageType Mapped : 1;
    StorageType UnusedBit3 : 1;
 
    StorageType UnusedBit4 : 1;
    StorageType UnusedBit5 : 1;
    StorageType UnusedBit6 : 1;
    StorageType UnusedBit7 : 1;
 
    StorageType UnusedBit8 : 1;
    StorageType CanAlias : 1;
    StorageType HostAccessSequentialWrite : 1;
    StorageType HostAccessRandom : 1;
 
    StorageType UnusedBit12 : 1;
    StorageType UnusedBit13 : 1;
    StorageType UnusedBit14 : 1;
    StorageType StrategyMinMemory : 1;
 
    StorageType StrategyMinTime : 1;
  };
};
PL_DECLARE_FLAGS_OPERATORS(plVulkanAllocationCreateFlags);
 
struct plVulkanMemoryUsage
{
  typedef plUInt8 StorageType;
  enum Enum
  {
    Unknown = 0,
    GpuLazilyAllocated = 6,
    Auto = 7,
    AutoPreferDevice = 8,
    AutoPreferHost = 9,
    Default = Unknown,
  };
};
 
struct plVulkanAllocationCreateInfo
{
  plBitflags<plVulkanAllocationCreateFlags> m_flags;
  plEnum<plVulkanMemoryUsage> m_usage;
  const char* m_pUserData = nullptr;
  bool m_bExportSharedAllocation = false; // If this allocation should be exported so other processes can access it.
};
 
struct plVulkanAllocationInfo
{
  uint32_t m_memoryType;
  vk::DeviceMemory m_deviceMemory;
  vk::DeviceSize m_offset;
  vk::DeviceSize m_size;
  void* m_pMappedData;
  void* m_pUserData;
  const char* m_pName;
};
 
 
VK_DEFINE_HANDLE(plVulkanAllocation)
 
 
class PL_RENDERERVULKAN_DLL plMemoryAllocatorVulkan
{
public:
  static vk::Result Initialize(vk::PhysicalDevice physicalDevice, vk::Device device, vk::Instance instance);
  static void DeInitialize();
 
  static vk::Result CreateImage(const vk::ImageCreateInfo& imageCreateInfo, const plVulkanAllocationCreateInfo& allocationCreateInfo, vk::Image& out_image, plVulkanAllocation& out_alloc, plVulkanAllocationInfo* pAllocInfo = nullptr);
  static void DestroyImage(vk::Image& image, plVulkanAllocation& alloc);
 
  static vk::Result CreateBuffer(const vk::BufferCreateInfo& bufferCreateInfo, const plVulkanAllocationCreateInfo& allocationCreateInfo, vk::Buffer& out_buffer, plVulkanAllocation& out_alloc, plVulkanAllocationInfo* pAllocInfo = nullptr);
  static void DestroyBuffer(vk::Buffer& buffer, plVulkanAllocation& alloc);
 
  static plVulkanAllocationInfo GetAllocationInfo(plVulkanAllocation alloc);
  static void SetAllocationUserData(plVulkanAllocation alloc, const char* pUserData);
 
  static vk::Result MapMemory(plVulkanAllocation alloc, void** pData);
  static void UnmapMemory(plVulkanAllocation alloc);
  static vk::Result FlushAllocation(plVulkanAllocation alloc, vk::DeviceSize offset = 0, vk::DeviceSize size = VK_WHOLE_SIZE);
  static vk::Result InvalidateAllocation(plVulkanAllocation alloc, vk::DeviceSize offset = 0, vk::DeviceSize size = VK_WHOLE_SIZE);
 
 
private:
  struct Impl;
  static Impl* m_pImpl;
};