Code/Engine/RendererVulkan/MemoryAllocator/MemoryAllocatorVulkan.h - dev - redgpu/ezEngine

Code/Engine/RendererVulkan/MemoryAllocator/MemoryAllocatorVulkan.h
127 строк4 KB
Sanakan8472
Copy / Readback fixes (#1963)
11 июн 2026, 18:07
11 июн 2026, 18:07b50d6f1
#pragma once

#include <Foundation/Types/Bitflags.h>
#include <RendererVulkan/Device/DeclarationsVulkan.h>
#include <RendererVulkan/RendererVulkanDLL.h>

/// \brief Subset of VmaAllocationCreateFlagBits. Duplicated for abstraction purposes.
struct ezVulkanAllocationCreateFlags
{
  using StorageType = ezUInt32;
  enum Enum
  {
    DedicatedMemory = 0x00000001,
    NeverAllocate = 0x00000002,
    Mapped = 0x00000004,
    CanAlias = 0x00000200,
    HostAccessSequentialWrite = 0x00000400,
    HostAccessRandom = 0x00000800,
    AllowTransferInstead = 0x00001000,
    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;
  };
};
EZ_DECLARE_FLAGS_OPERATORS(ezVulkanAllocationCreateFlags);

/// \brief Subset of VmaMemoryUsage. Duplicated for abstraction purposes.
struct ezVulkanMemoryUsage
{
  using StorageType = ezUInt8;
  enum Enum
  {
    Unknown = 0,
    GpuLazilyAllocated = 6,
    Auto = 7,
    AutoPreferDevice = 8,
    AutoPreferHost = 9,
    Default = Unknown,
  };
};

/// \brief Subset of VmaAllocationCreateInfo. Duplicated for abstraction purposes.
struct ezVulkanAllocationCreateInfo
{
  ezBitflags<ezVulkanAllocationCreateFlags> m_flags;
  ezEnum<ezVulkanMemoryUsage> m_usage;
  const char* m_pUserData = nullptr;
  bool m_bExportSharedAllocation = false; // If this allocation should be exported so other processes can access it.
};

/// \brief Subset of VmaAllocationInfo. Duplicated for abstraction purposes.
struct ezVulkanAllocationInfo
{
  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;
};

/// \brief Copy of VmaStatistics. Duplicated for abstraction purposes.
struct ezVulkanMemoryStatistics
{
  ezUInt32 m_uiBlockCount = 0;
  ezUInt32 m_uiAllocationCount = 0;
  ezUInt64 m_uiBlockBytes = 0;
  ezUInt64 m_uiAllocationBytes = 0;
};


/// \brief Thin abstraction layer over VulkanMemoryAllocator to allow for abstraction and prevent pulling in its massive header into other files.
/// Functions are a subset of VMA's. To be extended once a use-case comes up.
class EZ_RENDERERVULKAN_DLL ezMemoryAllocatorVulkan
{
public:
  static vk::Result Initialize(vk::PhysicalDevice physicalDevice, vk::Device device, vk::Instance instance, PFN_vkGetInstanceProcAddr instanceProcAddr, PFN_vkGetDeviceProcAddr deviceProcAddr);
  static void DeInitialize();

  static vk::Result CreateImage(const vk::ImageCreateInfo& imageCreateInfo, const ezVulkanAllocationCreateInfo& allocationCreateInfo, vk::Image& out_image, ezVulkanAllocation& out_pAlloc, ezVulkanAllocationInfo* pAllocInfo = nullptr);
  static void DestroyImage(vk::Image& ref_image, ezVulkanAllocation& ref_pAlloc);

  static vk::Result CreateBuffer(const vk::BufferCreateInfo& bufferCreateInfo, const ezVulkanAllocationCreateInfo& allocationCreateInfo, vk::Buffer& out_buffer, ezVulkanAllocation& out_pAlloc, ezVulkanAllocationInfo* pAllocInfo = nullptr);
  static void DestroyBuffer(vk::Buffer& ref_buffer, ezVulkanAllocation& ref_pAlloc);

  static ezVulkanAllocationInfo GetAllocationInfo(ezVulkanAllocation pAlloc);
  static vk::MemoryPropertyFlags GetAllocationFlags(ezVulkanAllocation pAlloc);
  static void SetAllocationUserData(ezVulkanAllocation pAlloc, const char* pUserData);

  static vk::Result MapMemory(ezVulkanAllocation pAlloc, void** pData);
  static void UnmapMemory(ezVulkanAllocation pAlloc);
  static vk::Result FlushAllocation(ezVulkanAllocation pAlloc, vk::DeviceSize offset = 0, vk::DeviceSize size = VK_WHOLE_SIZE);
  static vk::Result InvalidateAllocation(ezVulkanAllocation pAlloc, vk::DeviceSize offset = 0, vk::DeviceSize size = VK_WHOLE_SIZE);

  static ezVulkanMemoryStatistics GetStats();

private:
  struct Impl;
  static Impl* s_pImpl;
};