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;
  VkBuffer vk_buffer_ = VK_NULL_HANDLE;
  VmaAllocation allocation_ = VK_NULL_HANDLE;
  /* Pointer to the virtually mapped memory. */
  void *mapped_memory_ = nullptr;
 
 public:
  VKBuffer() = default;
  virtual ~VKBuffer();
 
  bool is_allocated() const;
  bool create(size_t size,
              GPUUsageType usage,
              VkBufferUsageFlags buffer_usage,
              bool is_host_visible = true);
  void clear(VKContext &context, uint32_t clear_value);
  void update_immediately(const void *data) const;
 
  void update_render_graph(VKContext &context, void *data) const;
  void flush() const;
  void read(VKContext &context, void *data) const;
 
  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;
 
  bool is_mapped() const;
 
 private:
  bool map();
  void unmap();
};
 
struct VKBufferWithOffset {
  const VkBuffer buffer;
  VkDeviceSize offset;
};
 
}  // namespace blender::gpu