vk_buffer.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "gpu_context_private.hh"
 
#include "BLI_utility_mixins.hh"
#include "vk_common.hh"
 
namespace blender::gpu {
class VKContext;
class VKDevice;

class VKBuffer : public NonCopyable {
  size_t size_in_bytes_ = 0;
  size_t alloc_size_in_bytes_ = 0;
  VkBuffer vk_buffer_ = VK_NULL_HANDLE;
  VmaAllocation allocation_ = VK_NULL_HANDLE;
  VkMemoryPropertyFlags vk_memory_property_flags_;
  TimelineValue async_timeline_ = 0;
  bool allocation_failed_ = false;
 
  /* Pointer to the virtually mapped memory. */
  void *mapped_memory_ = nullptr;
 
  VkDeviceAddress vk_device_address = 0;
 
 public:
  VKBuffer() = default;
  virtual ~VKBuffer();

  bool is_allocated() const;

  bool create(size_t size,
              VkBufferUsageFlags buffer_usage,
              VkMemoryPropertyFlags required_flags,
              VkMemoryPropertyFlags preferred_flags,
              VmaAllocationCreateFlags vma_allocation_flags,
              float priority,
              bool export_memory = false);
  void clear(VKContext &context, uint32_t clear_value);
  void update_immediately(const void *data) const;
  void update_sub_immediately(size_t start_offset, size_t data_size, const void *data) const;

  void update_render_graph(VKContext &context, void *data) const;
  void flush() const;

  void read(VKContext &context, void *data) const;

  void async_flush_to_host(VKContext &context);

  void read_async(VKContext &context, void *data);

  bool free();

  void free_immediately(VKDevice &device);
 
  int64_t size_in_bytes() const
  {
    return size_in_bytes_;
  }
 
  VkBuffer vk_handle() const
  {
    return vk_buffer_;
  }

  void *mapped_memory_get() const;
 
  VkDeviceAddress device_address_get() const
  {
    return vk_device_address;
  }

  bool is_mapped() const;

  VkDeviceMemory export_memory_get(size_t &memory_size);
 
 private:
  bool map();
  void unmap();
};
 
inline void *VKBuffer::mapped_memory_get() const
{
  BLI_assert_msg(this->is_mapped(), "Cannot access a non-mapped buffer.");
  return mapped_memory_;
}
 
inline bool VKBuffer::is_mapped() const
{
  return mapped_memory_ != nullptr;
}
 
inline bool VKBuffer::is_allocated() const
{
  return allocation_ != VK_NULL_HANDLE;
}

struct VKBufferWithOffset {
  const VkBuffer buffer;
  VkDeviceSize offset;
};
 
}  // namespace blender::gpu