Class Allocated

framework/core/allocated.h:124–391

 */
template <vkb::BindingType bindingType, typename HandleType>
class Allocated : public vkb::core::VulkanResource<bindingType, HandleType>
{
  public:
	using ParentType = vkb::core::VulkanResource<bindingType, HandleType>;

	using BufferType           = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::Buffer, VkBuffer>::type;
	using BufferCreateInfoType = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::BufferCreateInfo, VkBufferCreateInfo>::type;
	using DeviceMemoryType     = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::DeviceMemory, VkDeviceMemory>::type;
	using DeviceSizeType       = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::DeviceSize, VkDeviceSize>::type;
	using ImageCreateInfoType  = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::ImageCreateInfo, VkImageCreateInfo>::type;
	using ImageType            = typename std::conditional<bindingType == vkb::BindingType::Cpp, vk::Image, VkImage>::type;

  public:
	Allocated()                  = delete;
	Allocated(const Allocated &) = delete;
	Allocated(Allocated &&other) noexcept;
	Allocated &operator=(Allocated const &other) = delete;
	Allocated &operator=(Allocated &&other)      = default;

  protected:
	/**
	 * @brief The VMA-specific constructor for new objects. This should only be visible to derived classes.
	 * @param allocation_create_info All of the non-resource-specific information needed by the VMA to allocate the memory.
	 * @param args Additional constructor arguments needed for the derived class. Typically a `VkImageCreateInfo` or `VkBufferCreateInfo` struct.
	 */
	template <typename... Args>
	Allocated(const VmaAllocationCreateInfo &allocation_create_info, Args &&...args);

	/**
	 * @brief This constructor is used when the handle is already created, and the user wants to wrap it in an `Allocated` object.
	 * @note This constructor is used when the API provides us a pre-existing handle to something we didn't actually allocate, for instance
	 * when we allocate a swapchain and access the images in it.  In these cases the `allocation` member variable will remain null for the
	 * lifetime of the wrapper object (which is NOT necessarily the lifetime of the handle) and the wrapper will make no attempt to apply
	 * RAII semantics.
	 */
	Allocated(HandleType handle, vkb::core::Device<bindingType> *device_ = nullptr);

  public:
	const HandleType *get() const;

	/**
	 * @brief Flushes memory if it is NOT `HOST_COHERENT` (which also implies `HOST_VISIBLE`).
	 * This is a no-op for `HOST_COHERENT` memory.
	 *
	 * @param offset The offset into the memory to flush.  Defaults to 0.
	 * @param size The size of the memory to flush.  Defaults to the entire block of memory.
	 */
	void flush(DeviceSizeType offset = 0, DeviceSizeType size = VK_WHOLE_SIZE);

	/**
	 * @brief Retrieves a pointer to the host visible memory as an unsigned byte array.
	 * @return The pointer to the host visible memory.
	 * @note This performs no checking that the memory is actually mapped, so it's possible to get a nullptr
	 */
	const uint8_t *get_data() const;
	/**
	 * @brief Retrieves the raw Vulkan memory object.
	 * @return The Vulkan memory object.