Blender V5.3
blender::gpu::VertBuf Class Referenceabstract

#include <GPU_vertex_buffer.hh>

Inherited by blender::gpu::DummyVertexBuffer, blender::gpu::GLVertBuf, blender::gpu::MTLVertBuf, and blender::gpu::VKVertexBuffer.

Public Member Functions

 VertBuf ()
virtual ~VertBuf ()
void init (const GPUVertFormat &format, GPUUsageType usage)
void clear ()
void allocate (uint vert_len)
void resize (uint vert_len)
void upload ()
virtual void bind_as_ssbo (uint binding)=0
virtual void bind_as_texture (uint binding)=0
virtual void wrap_handle (uint64_t handle)=0
size_t size_alloc_get () const
size_t size_used_get () const
void reference_add ()
void reference_remove ()
GPUUsageType get_usage_type () const
template<typename T>
MutableSpan< T > data ()
virtual void update_sub (uint start, uint len, const void *data)=0
virtual void copy_sub (VertBuf &source_buf, uint source_first_vertex, uint dest_first_vertex, uint vertex_len)=0
 Copy from part of source vertex buffer into the vertex buffer.
virtual void read (void *data) const =0

Static Public Member Functions

template<typename FormatT>
static VertBufPtr from_size_with_format (const int size, GPUUsageType usage=GPU_USAGE_STATIC)
template<typename T>
static VertBufPtr from_size (const int size, GPUUsageType usage=GPU_USAGE_STATIC)
template<typename T>
static VertBufPtr from_span (const Span< T > data)
template<typename T>
static VertBufPtr from_varray (const VArray< T > &array)
template<typename T>
static VertBufPtr device_only (uint size)

Public Attributes

GPUVertFormat format = {}
uint vertex_len = 0
uint vertex_alloc = 0
GPUVertBufStatus flag = GPU_VERTBUF_INVALID
GPUUsageType extended_usage_ = GPU_USAGE_STATIC

Static Public Attributes

static size_t memory_usage = 0

Protected Member Functions

virtual void acquire_data ()=0
virtual void resize_data ()=0
virtual void release_data ()=0
virtual void upload_data ()=0

Protected Attributes

uchar * data_ = nullptr
GPUUsageType usage_ = GPU_USAGE_STATIC

Detailed Description

Implementation of Vertex Buffers. Base class which is then specialized for each implementation (GL, VK, ...).

Definition at line 92 of file GPU_vertex_buffer.hh.

Constructor & Destructor Documentation

◆ VertBuf()

◆ ~VertBuf()

blender::gpu::VertBuf::~VertBuf ( )
virtual

Definition at line 38 of file gpu_vertex_buffer.cc.

References blender::BLI_assert(), flag, and blender::GPU_VERTBUF_INVALID.

Member Function Documentation

◆ acquire_data()

virtual void blender::gpu::VertBuf::acquire_data ( )
protectedpure virtual

◆ allocate()

◆ bind_as_ssbo()

virtual void blender::gpu::VertBuf::bind_as_ssbo ( uint binding)
pure virtual

◆ bind_as_texture()

virtual void blender::gpu::VertBuf::bind_as_texture ( uint binding)
pure virtual

◆ clear()

void blender::gpu::VertBuf::clear ( )

◆ copy_sub()

virtual void blender::gpu::VertBuf::copy_sub ( VertBuf & source_buf,
uint source_first_vertex,
uint dest_first_vertex,
uint vertex_len )
pure virtual

Copy from part of source vertex buffer into the vertex buffer.

Note
: format of the vertex buffers should be identical.
: asserts when the copy range exceeds the used vertex range of either vertex buffer. Only that range is guaranteed to exist in the device buffer, the remainder of the allocated space is not uploaded by all backends.
: both vertex buffers must be uploaded to the GPU with GPU_vertbuf_use before calling.
Parameters
source_bufsource vertex buffer to copy data from.
source_first_vertexstarting vertex index to start copying the data from.
dest_first_vertexstarting vertex index to copy the data to.
vertex_lenthe number of vertices to copy.

Implemented in blender::gpu::DummyVertexBuffer, blender::gpu::GLVertBuf, blender::gpu::MTLVertBuf, and blender::gpu::VKVertexBuffer.

References VertBuf(), and vertex_len.

Referenced by blender::gpu::tests::test_vertex_buffer_copy_sub().

◆ data()

template<typename T>
MutableSpan< T > blender::gpu::VertBuf::data ( )
inline

Returns access to the data allocated for the vertex buffer. The size of the data type must match the data type used on the GPU.

Definition at line 220 of file GPU_vertex_buffer.hh.

References data_, blender::MutableSpan< T >::MutableSpan(), size_alloc_get(), and T.

Referenced by blender::draw::build_poly_other_map_vbo(), blender::draw::create_edit_points_data(), blender::draw::create_edit_points_position(), blender::draw::create_edit_points_position_vbo(), blender::draw::create_edit_points_radius(), blender::draw::create_edit_points_selection(), blender::draw::curve_create_attribute(), blender::draw::curve_create_edit_data_and_handles(), blender::draw::draw_subdiv_cache_update_extra_coarse_face_data(), blender::draw::DRW_vertbuf_create_wiredata(), blender::draw::GSplatEvalCache::ensure_attribute(), blender::draw::pbvh::extract_data_corner_bmesh(), blender::draw::pbvh::extract_data_corner_mesh(), blender::draw::pbvh::extract_data_face_bmesh(), blender::draw::pbvh::extract_data_face_mesh(), blender::draw::pbvh::extract_data_vert_bmesh(), blender::draw::pbvh::extract_data_vert_mesh(), blender::draw::extract_edge_index_subdiv(), blender::draw::extract_edit_subdiv_data_bm(), blender::draw::extract_edit_subdiv_data_mesh(), blender::draw::extract_edituv_lines_subdiv_bm(), blender::draw::extract_edituv_lines_subdiv_mesh(), blender::draw::extract_edituv_points_subdiv_bm(), blender::draw::extract_edituv_points_subdiv_mesh(), blender::draw::extract_edituv_stretch_area_subdiv(), blender::draw::extract_edituv_subdiv_data_bm(), blender::draw::extract_edituv_subdiv_data_mesh(), blender::draw::extract_lines_loose_geom_subdiv(), blender::draw::extract_lines_paint_mask_subdiv(), blender::draw::extract_points_subdiv_bm(), blender::draw::extract_points_subdiv_mesh(), blender::draw::extract_sculpt_data_subdiv(), blender::draw::extract_tangents_subdiv(), blender::draw::extract_vert_index_subdiv(), blender::draw::pbvh::fill_face_data_grids(), from_span(), blender::opensubdiv::EvalOutputAPI::getPatchMap(), blender::gpu::GLVertBuf::GLStorageBuf, blender::GPU_vertbuf_attr_fill_stride(), blender::GPU_vertbuf_attr_get_raw_data(), blender::GPU_vertbuf_attr_set(), blender::GPU_vertbuf_data_len_set(), blender::GPU_vertbuf_vert_set(), blender::draw::grease_pencil_edit_batch_ensure(), blender::draw::grease_pencil_geom_batch_ensure(), blender::draw::grease_pencil_weight_batch_ensure(), blender::immBeginBatch(), blender::draw::pbvh::interpolate_corner_data_for_flat_layout(), blender::draw::pbvh::interpolate_corner_data_for_standard_layout(), blender::draw::pbvh::interpolate_vert_data_for_flat_layout(), blender::draw::pbvh::interpolate_vert_data_for_standard_layout(), blender::draw::lattice_batch_cache_create_overlay_batches(), blender::draw::pointcloud_extract_attribute(), blender::draw::pointcloud_extract_position_and_radius(), blender::pygpu_vertbuf_fill(), blender::gpu::GLVertBuf::read(), blender::gpu::MTLVertBuf::read(), read(), blender::gpu::VKVertexBuffer::read(), blender::draw::test_draw_curves_interpolate_attributes(), blender::draw::test_draw_curves_interpolate_position(), blender::draw::test_draw_curves_lib(), blender::draw::test_draw_curves_topology(), blender::gpu::GLVertBuf::update_sub(), blender::gpu::MTLVertBuf::update_sub(), update_sub(), blender::gpu::VKVertexBuffer::update_sub(), blender::ui::waveform_draw_rgb(), and blender::wm_xr_controller_model_batch_create().

◆ device_only()

◆ from_size()

template<typename T>
VertBufPtr blender::gpu::VertBuf::from_size ( const int size,
GPUUsageType usage = GPU_USAGE_STATIC )
inlinestatic

◆ from_size_with_format()

template<typename FormatT>
VertBufPtr blender::gpu::VertBuf::from_size_with_format ( const int size,
GPUUsageType usage = GPU_USAGE_STATIC )
inlinestatic

◆ from_span()

◆ from_varray()

◆ get_usage_type()

GPUUsageType blender::gpu::VertBuf::get_usage_type ( ) const
inline

◆ init()

◆ read()

virtual void blender::gpu::VertBuf::read ( void * data) const
pure virtual

◆ reference_add()

void blender::gpu::VertBuf::reference_add ( )
inline

Definition at line 198 of file GPU_vertex_buffer.hh.

Referenced by blender::GPU_vertbuf_handle_ref_add().

◆ reference_remove()

void blender::gpu::VertBuf::reference_remove ( )
inline

◆ release_data()

virtual void blender::gpu::VertBuf::release_data ( )
protectedpure virtual

◆ resize()

void blender::gpu::VertBuf::resize ( uint vert_len)

◆ resize_data()

virtual void blender::gpu::VertBuf::resize_data ( )
protectedpure virtual

◆ size_alloc_get()

◆ size_used_get()

size_t blender::gpu::VertBuf::size_used_get ( ) const
inline

◆ update_sub()

virtual void blender::gpu::VertBuf::update_sub ( uint start,
uint len,
const void * data )
pure virtual

◆ upload()

void blender::gpu::VertBuf::upload ( )

◆ upload_data()

virtual void blender::gpu::VertBuf::upload_data ( )
protectedpure virtual

◆ wrap_handle()

virtual void blender::gpu::VertBuf::wrap_handle ( uint64_t handle)
pure virtual

Member Data Documentation

◆ data_

◆ extended_usage_

GPUUsageType blender::gpu::VertBuf::extended_usage_ = GPU_USAGE_STATIC

Usage including extended usage flags.

Definition at line 106 of file GPU_vertex_buffer.hh.

Referenced by init().

◆ flag

◆ format

◆ memory_usage

size_t blender::gpu::VertBuf::memory_usage = 0
static

◆ usage_

◆ vertex_alloc

uint blender::gpu::VertBuf::vertex_alloc = 0

◆ vertex_len


The documentation for this class was generated from the following files: