Clément Foucault
7e0e07657c
Documented all functions, adding use case and side effects. Also replace the use of shortened argument name by more meaningful ones. Renamed `GPU_batch_instbuf_add_ex` and `GPU_batch_vertbuf_add_ex` to remove the `ex` suffix as they are the main version used (removed the few usage of the other version). Renamed `GPU_batch_draw_instanced` to `GPU_batch_draw_instance_range` and make it consistent with `GPU_batch_draw_range`.
82 lines
2.3 KiB
C++
82 lines
2.3 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later
|
|
* Copyright 2016 Blender Foundation. */
|
|
|
|
/** \file
|
|
* \ingroup draw
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "GPU_batch.h"
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
/* Common */
|
|
// #define DRW_DEBUG_MESH_CACHE_REQUEST
|
|
|
|
#ifdef DRW_DEBUG_MESH_CACHE_REQUEST
|
|
# define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) \
|
|
(flag |= DRW_vbo_requested(vbo) ? (printf(" VBO requested " #vbo "\n") ? value : value) : 0)
|
|
# define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) \
|
|
(flag |= DRW_ibo_requested(ibo) ? (printf(" IBO requested " #ibo "\n") ? value : value) : 0)
|
|
#else
|
|
# define DRW_ADD_FLAG_FROM_VBO_REQUEST(flag, vbo, value) \
|
|
(flag |= DRW_vbo_requested(vbo) ? (value) : 0)
|
|
# define DRW_ADD_FLAG_FROM_IBO_REQUEST(flag, ibo, value) \
|
|
(flag |= DRW_ibo_requested(ibo) ? (value) : 0)
|
|
#endif
|
|
|
|
BLI_INLINE GPUBatch *DRW_batch_request(GPUBatch **batch)
|
|
{
|
|
/* XXX TODO(fclem): We are writing to batch cache here. Need to make this thread safe. */
|
|
if (*batch == NULL) {
|
|
*batch = GPU_batch_calloc();
|
|
}
|
|
return *batch;
|
|
}
|
|
|
|
BLI_INLINE bool DRW_batch_requested(GPUBatch *batch, GPUPrimType prim_type)
|
|
{
|
|
/* Batch has been requested if it has been created but not initialized. */
|
|
if (batch != NULL && batch->verts[0] == NULL) {
|
|
/* HACK. We init without a valid VBO and let the first vbo binding
|
|
* fill verts[0]. */
|
|
GPU_batch_init_ex(batch, prim_type, (GPUVertBuf *)1, NULL, (eGPUBatchFlag)0);
|
|
batch->verts[0] = NULL;
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
BLI_INLINE void DRW_ibo_request(GPUBatch *batch, GPUIndexBuf **ibo)
|
|
{
|
|
if (*ibo == NULL) {
|
|
*ibo = GPU_indexbuf_calloc();
|
|
}
|
|
if (batch != NULL) {
|
|
GPU_batch_elembuf_set(batch, *ibo, false);
|
|
}
|
|
}
|
|
|
|
BLI_INLINE bool DRW_ibo_requested(GPUIndexBuf *ibo)
|
|
{
|
|
/* TODO: do not rely on data uploaded. This prevents multi-threading.
|
|
* (need access to a OpenGL context). */
|
|
return (ibo != NULL && !GPU_indexbuf_is_init(ibo));
|
|
}
|
|
|
|
BLI_INLINE void DRW_vbo_request(GPUBatch *batch, GPUVertBuf **vbo)
|
|
{
|
|
if (*vbo == NULL) {
|
|
*vbo = GPU_vertbuf_calloc();
|
|
}
|
|
if (batch != NULL) {
|
|
/* HACK we set VBO's that may not yet be valid. */
|
|
GPU_batch_vertbuf_add(batch, *vbo, false);
|
|
}
|
|
}
|
|
|
|
BLI_INLINE bool DRW_vbo_requested(GPUVertBuf *vbo)
|
|
{
|
|
return (vbo != NULL && (GPU_vertbuf_get_status(vbo) & GPU_VERTBUF_INIT) == 0);
|
|
}
|