This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/gpu/intern/gpu_storage_buffer_private.hh
Clément Foucault fe195f51d1 GPUStorageBuf: Add read() function to readback buffer data to host
This is not expected to be fast. This is only for inspecting the content
of the buffer for debugging or validation purpose.
2022-08-30 22:26:11 +02:00

68 lines
1.6 KiB
C++

/* SPDX-License-Identifier: GPL-2.0-or-later
* Copyright 2022 Blender Foundation. All rights reserved. */
/** \file
* \ingroup gpu
*/
#pragma once
#include "BLI_sys_types.h"
struct GPUStorageBuf;
namespace blender {
namespace gpu {
#ifdef DEBUG
# define DEBUG_NAME_LEN 64
#else
# define DEBUG_NAME_LEN 8
#endif
/**
* Implementation of Storage Buffers.
* Base class which is then specialized for each implementation (GL, VK, ...).
*/
class StorageBuf {
protected:
/** Data size in bytes. */
size_t size_in_bytes_;
/** Continuous memory block to copy to GPU. This data is owned by the StorageBuf. */
void *data_ = nullptr;
/** Debugging name */
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(eGPUTextureFormat internal_format,
eGPUDataFormat data_format,
void *data) = 0;
virtual void copy_sub(VertBuf *src, uint dst_offset, uint src_offset, uint copy_size) = 0;
virtual void read(void *data) = 0;
};
/* Syntactic sugar. */
static inline GPUStorageBuf *wrap(StorageBuf *vert)
{
return reinterpret_cast<GPUStorageBuf *>(vert);
}
static inline StorageBuf *unwrap(GPUStorageBuf *vert)
{
return reinterpret_cast<StorageBuf *>(vert);
}
static inline const StorageBuf *unwrap(const GPUStorageBuf *vert)
{
return reinterpret_cast<const StorageBuf *>(vert);
}
#undef DEBUG_NAME_LEN
} // namespace gpu
} // namespace blender