Sergey Sharybin
a12a8a71bb
The goal is to solve confusion of the "All rights reserved" for licensing
code under an open-source license.
The phrase "All rights reserved" comes from a historical convention that
required this phrase for the copyright protection to apply. This convention
is no longer relevant.
However, even though the phrase has no meaning in establishing the copyright
it has not lost meaning in terms of licensing.
This change makes it so code under the Blender Foundation copyright does
not use "all rights reserved". This is also how the GPL license itself
states how to apply it to the source code:
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software ...
This change does not change copyright notice in cases when the copyright
is dual (BF and an author), or just an author of the code. It also does
mot change copyright which is inherited from NaN Holding BV as it needs
some further investigation about what is the proper way to handle it.
72 lines
2.2 KiB
C++
72 lines
2.2 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2022 Blender Foundation */
|
|
|
|
/** \file
|
|
* \ingroup gpu
|
|
*
|
|
* Storage buffers API. Used to handle many way bigger buffers than Uniform buffers update at once.
|
|
* Make sure that the data structure is compatible with what the implementation expect.
|
|
* (see "7.8 Shader Buffer Variables and Shader Storage Blocks" from the OpenGL spec for more info
|
|
* about std430 layout)
|
|
* Rule of thumb: Padding to 16bytes, don't use vec3.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "GPU_texture.h"
|
|
#include "GPU_vertex_buffer.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/** Opaque type hiding blender::gpu::StorageBuf. */
|
|
typedef struct GPUStorageBuf GPUStorageBuf;
|
|
|
|
GPUStorageBuf *GPU_storagebuf_create_ex(size_t size,
|
|
const void *data,
|
|
GPUUsageType usage,
|
|
const char *name);
|
|
|
|
#define GPU_storagebuf_create(size) \
|
|
GPU_storagebuf_create_ex(size, NULL, GPU_USAGE_DYNAMIC, __func__);
|
|
|
|
void GPU_storagebuf_free(GPUStorageBuf *ssbo);
|
|
|
|
void GPU_storagebuf_update(GPUStorageBuf *ssbo, const void *data);
|
|
|
|
void GPU_storagebuf_bind(GPUStorageBuf *ssbo, int slot);
|
|
void GPU_storagebuf_unbind(GPUStorageBuf *ssbo);
|
|
void GPU_storagebuf_unbind_all(void);
|
|
|
|
void GPU_storagebuf_clear_to_zero(GPUStorageBuf *ssbo);
|
|
|
|
/**
|
|
* Clear the content of the buffer using the given #clear_value. #clear_value will be used as a
|
|
* repeatable pattern of 32bits.
|
|
*/
|
|
void GPU_storagebuf_clear(GPUStorageBuf *ssbo, uint32_t clear_value);
|
|
|
|
/**
|
|
* Read back content of the buffer to CPU for inspection.
|
|
* Slow! Only use for inspection / debugging.
|
|
* NOTE: Not synchronized. Use appropriate barrier before reading.
|
|
*/
|
|
void GPU_storagebuf_read(GPUStorageBuf *ssbo, void *data);
|
|
|
|
/**
|
|
* \brief Copy a part of a vertex buffer to a storage buffer.
|
|
*
|
|
* \param ssbo: destination storage buffer
|
|
* \param src: source vertex buffer
|
|
* \param dst_offset: where to start copying to (in bytes).
|
|
* \param src_offset: where to start copying from (in bytes).
|
|
* \param copy_size: byte size of the segment to copy.
|
|
*/
|
|
void GPU_storagebuf_copy_sub_from_vertbuf(
|
|
GPUStorageBuf *ssbo, GPUVertBuf *src, uint dst_offset, uint src_offset, uint copy_size);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|