gpu_storage_buffer_private.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2022 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "BLI_span.hh"
#include "BLI_sys_types.h"
 
struct GPUStorageBuf;
 
namespace blender {
namespace gpu {
 
class VertBuf;
 
#ifndef NDEBUG
#  define DEBUG_NAME_LEN 64
#else
#  define DEBUG_NAME_LEN 8
#endif
 
class StorageBuf {
 protected:
  size_t size_in_bytes_;
  void *data_ = nullptr;
  char name_[DEBUG_NAME_LEN];
 
 public:
  StorageBuf(size_t size, const char *name);
  virtual ~StorageBuf();
 
  virtual void update(const void *data) = 0;
  virtual void bind(int slot) = 0;
  virtual void unbind() = 0;
  virtual void clear(uint32_t clear_value) = 0;
  virtual void copy_sub(VertBuf *src, uint dst_offset, uint src_offset, uint copy_size) = 0;
  virtual void read(void *data) = 0;
  virtual void async_flush_to_host() = 0;
  virtual void sync_as_indirect_buffer() = 0;
};
 
/* Syntactic sugar. */
static inline GPUStorageBuf *wrap(StorageBuf *storage_buf)
{
  return reinterpret_cast<GPUStorageBuf *>(storage_buf);
}
static inline StorageBuf *unwrap(GPUStorageBuf *storage_buf)
{
  return reinterpret_cast<StorageBuf *>(storage_buf);
}
static inline const StorageBuf *unwrap(const GPUStorageBuf *storage_buf)
{
  return reinterpret_cast<const StorageBuf *>(storage_buf);
}
 
#undef DEBUG_NAME_LEN
 
}  // namespace gpu
}  // namespace blender