#include "BLI_compiler_attrs.h"
#include "BLI_sys_types.h"
#include "GPU_batch.hh"

Macros
#define	MAX_INSTANCE_DATA_SIZE 64 /* Can be adjusted for more */

#define	DRW_BUFFER_VERTS_CHUNK 128

Functions
void *	DRW_instance_data_next (DRWInstanceData *idata)

DRWInstanceData *	DRW_instance_data_request (DRWInstanceDataList *idatalist, uint attr_size)

blender::gpu::VertBuf *	DRW_temp_buffer_request (DRWInstanceDataList idatalist, GPUVertFormat format, int *vert_len)

blender::gpu::Batch *	DRW_temp_batch_instance_request (DRWInstanceDataList idatalist, blender::gpu::VertBuf buf, blender::gpu::Batch instancer, blender::gpu::Batch geom)

blender::gpu::Batch *	DRW_temp_batch_request (DRWInstanceDataList idatalist, blender::gpu::VertBuf buf, GPUPrimType type)

void	DRW_instance_buffer_finish (DRWInstanceDataList *idatalist)

void	DRW_instance_data_list_reset (DRWInstanceDataList *idatalist)

void	DRW_instance_data_list_free_unused (DRWInstanceDataList *idatalist)

void	DRW_instance_data_list_resize (DRWInstanceDataList *idatalist)

DRWSparseUniformBuf *	DRW_sparse_uniform_buffer_new (unsigned int item_size, unsigned int chunk_size)

void	DRW_sparse_uniform_buffer_flush (DRWSparseUniformBuf *buffer)

void	DRW_sparse_uniform_buffer_clear (DRWSparseUniformBuf *buffer, bool free_all)

void	DRW_sparse_uniform_buffer_free (DRWSparseUniformBuf *buffer)

bool	DRW_sparse_uniform_buffer_is_empty (DRWSparseUniformBuf *buffer)

void	DRW_sparse_uniform_buffer_bind (DRWSparseUniformBuf *buffer, int chunk, int location)

void	DRW_sparse_uniform_buffer_unbind (DRWSparseUniformBuf *buffer, int chunk)

void *	DRW_sparse_uniform_buffer_ensure_item (DRWSparseUniformBuf *buffer, int chunk, int item)

GHash *	DRW_uniform_attrs_pool_new ()

void	DRW_uniform_attrs_pool_flush_all (GHash *table)

void	DRW_uniform_attrs_pool_clear_all (GHash *table)

DRWSparseUniformBuf *	DRW_uniform_attrs_pool_find_ubo (GHash table, const GPUUniformAttrList key)

Macro Definition Documentation

◆ DRW_BUFFER_VERTS_CHUNK

#define DRW_BUFFER_VERTS_CHUNK 128

Definition at line 18 of file draw_instance_data.hh.

Referenced by DRW_buffer_add_entry_array(), DRW_buffer_add_entry_struct(), DRW_instance_buffer_finish(), and DRW_temp_buffer_request().

◆ MAX_INSTANCE_DATA_SIZE

#define MAX_INSTANCE_DATA_SIZE 64 /* Can be adjusted for more */

Definition at line 16 of file draw_instance_data.hh.

Referenced by DRW_drawdata_ensure(), DRW_instance_data_list_free(), DRW_instance_data_list_free_unused(), DRW_instance_data_list_reset(), DRW_instance_data_list_resize(), and DRW_instance_data_request().

Function Documentation

◆ DRW_instance_buffer_finish()

void DRW_instance_buffer_finish ( DRWInstanceDataList * idatalist )

Upload all instance data to the GPU as soon as possible.

Definition at line 204 of file draw_instance_data.cc.

References batch, DRWTempInstancingHandle::batch, BLI_memblock_clear(), BLI_memblock_iternew(), BLI_memblock_iterstep(), DRWTempInstancingHandle::buf, DRW_BUFFER_VERTS_CHUNK, DRWTempInstancingHandle::geom, GPU_BATCH_BUILDING, GPU_batch_copy(), GPU_BATCH_INST_VBO_MAX_LEN, GPU_batch_instbuf_add(), GPU_vertbuf_data_len_set(), GPU_vertbuf_data_resize(), GPU_vertbuf_get_vertex_alloc(), GPU_vertbuf_use(), DRWTempInstancingHandle::instancer, instancing_batch_references_add(), DRWInstanceDataList::pool_batching, DRWInstanceDataList::pool_buffers, DRWInstanceDataList::pool_instancing, temp_batch_free(), temp_buffer_handle_free(), and temp_instancing_handle_free().

Referenced by DRW_render_instance_buffer_finish().

◆ DRW_instance_data_list_free_unused()

void DRW_instance_data_list_free_unused ( DRWInstanceDataList * idatalist )

Definition at line 363 of file draw_instance_data.cc.

References DRW_instance_data_free(), DRWInstanceDataList::idata_head, DRWInstanceDataList::idata_tail, MAX_INSTANCE_DATA_SIZE, MEM_freeN(), DRWInstanceData::next, and DRWInstanceData::used.

Referenced by drw_viewport_data_reset().

◆ DRW_instance_data_list_reset()

void DRW_instance_data_list_reset ( DRWInstanceDataList * idatalist )

Definition at line 352 of file draw_instance_data.cc.

References DRWInstanceDataList::idata_head, MAX_INSTANCE_DATA_SIZE, DRWInstanceData::next, and DRWInstanceData::used.

Referenced by drw_viewport_data_reset().

◆ DRW_instance_data_list_resize()

void DRW_instance_data_list_resize ( DRWInstanceDataList * idatalist )

Definition at line 393 of file draw_instance_data.cc.

References BLI_mempool_clear_ex(), BLI_mempool_len(), DRWInstanceDataList::idata_head, MAX_INSTANCE_DATA_SIZE, DRWInstanceData::mempool, and DRWInstanceData::next.

Referenced by drw_viewport_data_reset().

◆ DRW_instance_data_next()

void * DRW_instance_data_next ( DRWInstanceData * idata )

Return a pointer to the next instance data space.

Definition at line 287 of file draw_instance_data.cc.

References BLI_mempool_alloc(), and DRWInstanceData::mempool.

Referenced by DRW_drawdata_ensure().

◆ DRW_instance_data_request()

DRWInstanceData * DRW_instance_data_request	(	DRWInstanceDataList *	idatalist,
		uint	attr_size )

Definition at line 292 of file draw_instance_data.cc.

References attr_size(), BLI_assert, drw_instance_data_create(), DRWInstanceDataList::idata_head, MAX_INSTANCE_DATA_SIZE, DRWInstanceData::next, and DRWInstanceData::used.

Referenced by DRW_drawdata_ensure().

◆ DRW_sparse_uniform_buffer_bind()

void DRW_sparse_uniform_buffer_bind	(	DRWSparseUniformBuf *	buffer,
		int	chunk,
		int	location )

Bind the UBO for the given chunk, if present. A nullptr buffer pointer is handled as empty.

Definition at line 520 of file draw_instance_data.cc.

References drw_sparse_uniform_buffer_get_ubo(), and GPU_uniformbuf_bind().

Referenced by draw_call_resource_bind(), and draw_update_uniforms().

◆ DRW_sparse_uniform_buffer_clear()

void DRW_sparse_uniform_buffer_clear	(	DRWSparseUniformBuf *	buffer,
		bool	free_all )

Clean all buffers and free unused ones.

Definition at line 458 of file draw_instance_data.cc.

References BLI_BITMAP_RESIZE, BLI_bitmap_set_all(), BLI_BITMAP_TEST, DRWSparseUniformBuf::chunk_buffers, CHUNK_LIST_STEP, DRWSparseUniformBuf::chunk_ubos, DRWSparseUniformBuf::chunk_used, GPU_uniformbuf_free(), MEM_recallocN, MEM_SAFE_FREE, and DRWSparseUniformBuf::num_chunks.

Referenced by DRW_sparse_uniform_buffer_free(), DRW_uniform_attrs_pool_clear_all(), and drw_uniform_attrs_pool_free_cb().

◆ DRW_sparse_uniform_buffer_ensure_item()

void * DRW_sparse_uniform_buffer_ensure_item	(	DRWSparseUniformBuf *	buffer,
		int	chunk,
		int	item )

Returns a pointer to the given item of the given chunk, allocating memory if necessary.

Definition at line 536 of file draw_instance_data.cc.

References BLI_BITMAP_ENABLE, BLI_BITMAP_RESIZE, BLI_BITMAP_TEST, DRWSparseUniformBuf::chunk_buffers, DRWSparseUniformBuf::chunk_bytes, CHUNK_LIST_STEP, DRWSparseUniformBuf::chunk_ubos, DRWSparseUniformBuf::chunk_used, DRWSparseUniformBuf::item_size, MEM_callocN, MEM_recallocN, and DRWSparseUniformBuf::num_chunks.

Referenced by drw_uniform_attrs_pool_update().

◆ DRW_sparse_uniform_buffer_flush()

void DRW_sparse_uniform_buffer_flush ( DRWSparseUniformBuf * buffer )

Flush data from ordinary memory to UBOs.

Definition at line 446 of file draw_instance_data.cc.

References BLI_BITMAP_TEST, DRWSparseUniformBuf::chunk_buffers, DRWSparseUniformBuf::chunk_bytes, DRWSparseUniformBuf::chunk_ubos, DRWSparseUniformBuf::chunk_used, GPU_uniformbuf_create, GPU_uniformbuf_update(), and DRWSparseUniformBuf::num_chunks.

Referenced by DRW_uniform_attrs_pool_flush_all().

◆ DRW_sparse_uniform_buffer_free()

void DRW_sparse_uniform_buffer_free ( DRWSparseUniformBuf * buffer )

Frees the buffer.

Definition at line 501 of file draw_instance_data.cc.

References DRW_sparse_uniform_buffer_clear(), and MEM_freeN().

◆ DRW_sparse_uniform_buffer_is_empty()

bool DRW_sparse_uniform_buffer_is_empty ( DRWSparseUniformBuf * buffer )

Checks if the buffer contains any allocated chunks.

Definition at line 507 of file draw_instance_data.cc.

References DRWSparseUniformBuf::num_chunks.

Referenced by DRW_uniform_attrs_pool_clear_all().

◆ DRW_sparse_uniform_buffer_new()

DRWSparseUniformBuf * DRW_sparse_uniform_buffer_new	(	unsigned int	item_size,
		unsigned int	chunk_size )

Allocate a chunked UBO with the specified item and chunk size.

Definition at line 438 of file draw_instance_data.cc.

References drw_sparse_uniform_buffer_init(), and MEM_mallocN.

◆ DRW_sparse_uniform_buffer_unbind()

void DRW_sparse_uniform_buffer_unbind	(	DRWSparseUniformBuf *	buffer,
		int	chunk )

Unbind the UBO for the given chunk, if present. A nullptr buffer pointer is handled as empty.

Definition at line 528 of file draw_instance_data.cc.

References drw_sparse_uniform_buffer_get_ubo(), and GPU_uniformbuf_unbind().

Referenced by draw_call_batching_finish(), and draw_call_resource_bind().

◆ DRW_temp_batch_instance_request()

blender::gpu::Batch * DRW_temp_batch_instance_request	(	DRWInstanceDataList *	idatalist,
		blender::gpu::VertBuf *	buf,
		blender::gpu::Batch *	instancer,
		blender::gpu::Batch *	geom )

Note: Does not return a valid drawable batch until DRW_instance_buffer_finish has run. Initialization is delayed because instancer or geom could still not be initialized.

Definition at line 126 of file draw_instance_data.cc.

References batch, DRWTempInstancingHandle::batch, BLI_assert, BLI_memblock_alloc(), GPU_BATCH_BUILDING, GPU_batch_calloc(), GPU_batch_clear(), GPU_BATCH_VBO_MAX_LEN, GPU_VERTBUF_DATA_UPLOADED, GPU_vertbuf_get_status(), instancing_batch_references_remove(), and DRWInstanceDataList::pool_instancing.

Referenced by DRW_shgroup_call_buffer_instance(), and DRW_shgroup_call_instances_with_attrs().

◆ DRW_temp_batch_request()

blender::gpu::Batch * DRW_temp_batch_request	(	DRWInstanceDataList *	idatalist,
		blender::gpu::VertBuf *	buf,
		GPUPrimType	type )

Note: Use only with buf allocated via DRW_temp_buffer_request.

Definition at line 167 of file draw_instance_data.cc.

References batch, BLI_memblock_alloc(), GPU_batch_calloc(), GPU_batch_clear(), GPU_batch_init, GPU_VERTBUF_DATA_UPLOADED, GPU_vertbuf_get_status(), and DRWInstanceDataList::pool_batching.

Referenced by DRW_shgroup_call_buffer().

◆ DRW_temp_buffer_request()

blender::gpu::VertBuf * DRW_temp_buffer_request	(	DRWInstanceDataList *	idatalist,
		GPUVertFormat *	format,
		int *	vert_len )

This manager allows to distribute existing batches for instancing attributes. This reduce the number of batches creation. Querying a batch is done with a vertex format. This format should be static so that its pointer never changes (because we are using this pointer as identifier [we don't want to check the full format that would be too slow]).

Definition at line 102 of file draw_instance_data.cc.

References BLI_assert, BLI_memblock_alloc(), DRW_BUFFER_VERTS_CHUNK, DRWTempBufferHandle::format, GPU_USAGE_DYNAMIC, GPU_vertbuf_calloc(), GPU_vertbuf_data_alloc(), GPU_VERTBUF_DISCARD_SAFE, GPU_vertbuf_init_with_format_ex(), and DRWInstanceDataList::pool_buffers.

Referenced by DRW_shgroup_call_buffer(), and DRW_shgroup_call_buffer_instance().