Blender V4.3
Public Member Functions | List of all members
blender::gpu::MTLStorageBuf Class Reference

#include <mtl_storage_buffer.hh>

Inherits blender::gpu::StorageBuf.

Public Member Functions

void sync_as_indirect_buffer () override
 
const char * get_name ()
 
Creation & Deletion
 MTLStorageBuf (size_t size, GPUUsageType usage, const char *name)
 
 ~MTLStorageBuf ()
 
 MTLStorageBuf (MTLUniformBuf *uniform_buf, size_t size)
 
 MTLStorageBuf (MTLVertBuf *uniform_buf, size_t size)
 
 MTLStorageBuf (MTLIndexBuf *uniform_buf, size_t size)
 
 MTLStorageBuf (MTLTexture *texture, size_t size)
 
Data upload / update
void update (const void *data) override
 
void init ()
 
Usage
void bind (int slot) override
 
void unbind () override
 
void clear (uint32_t clear_value) override
 
void copy_sub (VertBuf *src, uint dst_offset, uint src_offset, uint copy_size) override
 
void read (void *data) override
 
void async_flush_to_host () override
 
id< MTLBuffer > get_metal_buffer ()
 
size_t get_size ()
 
- Public Member Functions inherited from blender::gpu::StorageBuf
 StorageBuf (size_t size, const char *name)
 
virtual ~StorageBuf ()
 

Additional Inherited Members

- Protected Attributes inherited from blender::gpu::StorageBuf
size_t size_in_bytes_
 
void * data_ = nullptr
 
char name_ [DEBUG_NAME_LEN]
 

Detailed Description

Implementation of Storage Buffers using Metal.

Definition at line 26 of file mtl_storage_buffer.hh.

Constructor & Destructor Documentation

◆ MTLStorageBuf() [1/5]

blender::gpu::MTLStorageBuf::MTLStorageBuf ( size_t size,
GPUUsageType usage,
const char * name )

Definition at line 30 of file mtl_storage_buffer.mm.

References metal_buffer_.

◆ ~MTLStorageBuf()

blender::gpu::MTLStorageBuf::~MTLStorageBuf ( )

Definition at line 75 of file mtl_storage_buffer.mm.

References blender::gpu::MTLStorageBufferBinding::bound, blender::gpu::MTLBuffer::free(), blender::gpu::MTLContext::get(), metal_buffer_, MTL_MAX_BUFFER_BINDINGS, blender::gpu::MTLContext::pipeline_state, blender::gpu::MTLStorageBufferBinding::ssbo, and blender::gpu::MTLContextGlobalShaderPipelineState::ssbo_bindings.

◆ MTLStorageBuf() [2/5]

blender::gpu::MTLStorageBuf::MTLStorageBuf ( MTLUniformBuf * uniform_buf,
size_t size )

Definition at line 39 of file mtl_storage_buffer.mm.

References BLI_assert, GPU_USAGE_DYNAMIC, uniform_buf(), and uniform_buffer_.

◆ MTLStorageBuf() [3/5]

blender::gpu::MTLStorageBuf::MTLStorageBuf ( MTLVertBuf * uniform_buf,
size_t size )

Definition at line 48 of file mtl_storage_buffer.mm.

References BLI_assert, GPU_USAGE_DYNAMIC, and vertex_buffer_.

◆ MTLStorageBuf() [4/5]

blender::gpu::MTLStorageBuf::MTLStorageBuf ( MTLIndexBuf * uniform_buf,
size_t size )

Definition at line 57 of file mtl_storage_buffer.mm.

References BLI_assert, GPU_USAGE_DYNAMIC, and index_buffer_.

◆ MTLStorageBuf() [5/5]

blender::gpu::MTLStorageBuf::MTLStorageBuf ( MTLTexture * texture,
size_t size )

Definition at line 66 of file mtl_storage_buffer.mm.

References BLI_assert, GPU_USAGE_DYNAMIC, texture, and texture_.

Member Function Documentation

◆ async_flush_to_host()

void blender::gpu::MTLStorageBuf::async_flush_to_host ( )
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 343 of file mtl_storage_buffer.mm.

References BLI_assert, BLI_assert_msg, blender::gpu::MTLContext::device, blender::gpu::MTLCommandBufferManager::encode_signal_event(), blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder(), blender::gpu::MTLContext::get(), blender::gpu::MTLBuffer::get_metal_buffer(), GPU_flush(), GPU_USAGE_DEVICE_ONLY, init(), blender::gpu::MTLContext::main_command_buffer, and metal_buffer_.

◆ bind()

void blender::gpu::MTLStorageBuf::bind ( int slot)
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 212 of file mtl_storage_buffer.mm.

References BLI_assert, blender::gpu::MTLStorageBufferBinding::bound, blender::gpu::StorageBuf::data_, blender::gpu::MTLContext::get(), init(), MEM_SAFE_FREE, metal_buffer_, MTL_MAX_BUFFER_BINDINGS, blender::gpu::StorageBuf::name_, blender::gpu::MTLContext::pipeline_state, blender::gpu::MTLStorageBufferBinding::ssbo, blender::gpu::MTLContextGlobalShaderPipelineState::ssbo_bindings, and update().

Referenced by blender::gpu::MTLIndexBuf::bind_as_ssbo(), blender::gpu::MTLUniformBuf::bind_as_ssbo(), blender::gpu::MTLVertBuf::bind_as_ssbo(), blender::gpu::MTLContext::ensure_texture_bindings(), and blender::gpu::MTLContext::ensure_texture_bindings().

◆ clear()

void blender::gpu::MTLStorageBuf::clear ( uint32_t clear_value)
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 271 of file mtl_storage_buffer.mm.

References blender::gpu::MTLComputeState::bind_compute_buffer(), blender::gpu::MTLComputeState::bind_compute_bytes(), blender::gpu::MTLComputeState::bind_pso(), BLI_assert_msg, blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder(), blender::gpu::MTLCommandBufferManager::ensure_begin_compute_encoder(), blender::gpu::MTLContext::get(), blender::gpu::MTLContextComputeUtils::get_buffer_clear_pso(), blender::gpu::MTLCommandBufferManager::get_compute_state(), blender::gpu::MTLContext::get_compute_utils(), blender::gpu::MTLBuffer::get_metal_buffer(), init(), blender::gpu::MTLContext::main_command_buffer, metal_buffer_, range, and blender::gpu::StorageBuf::size_in_bytes_.

◆ copy_sub()

void blender::gpu::MTLStorageBuf::copy_sub ( VertBuf * src,
uint dst_offset,
uint src_offset,
uint copy_size )
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 310 of file mtl_storage_buffer.mm.

References blender::gpu::MTLVertBuf::bind(), BLI_assert, blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder(), blender::gpu::MTLContext::get(), blender::gpu::MTLBuffer::get_metal_buffer(), init(), blender::gpu::MTLContext::main_command_buffer, metal_buffer_, and size().

◆ get_metal_buffer()

id< MTLBuffer > blender::gpu::MTLStorageBuf::get_metal_buffer ( )

Definition at line 457 of file mtl_storage_buffer.mm.

References BLI_assert, BLI_assert_msg, blender::gpu::StorageBuf::data_, blender::gpu::MTLBuffer::debug_ensure_used(), blender::gpu::MTLBuffer::get_metal_buffer(), index_buffer_, metal_buffer_, tex, texture_, uniform_buffer_, UNUSED_VARS_NDEBUG, and vertex_buffer_.

Referenced by blender::gpu::MTLContext::compute_dispatch_indirect(), blender::gpu::MTLContext::ensure_buffer_bindings(), and blender::gpu::MTLContext::ensure_buffer_bindings().

◆ get_name()

const char * blender::gpu::MTLStorageBuf::get_name ( )
inline

Definition at line 85 of file mtl_storage_buffer.hh.

References blender::gpu::StorageBuf::name_.

◆ get_size()

size_t blender::gpu::MTLStorageBuf::get_size ( )

Definition at line 506 of file mtl_storage_buffer.mm.

References BLI_assert, and blender::gpu::StorageBuf::size_in_bytes_.

Referenced by blender::gpu::MTLContext::ensure_buffer_bindings(), blender::gpu::MTLContext::ensure_buffer_bindings(), and update().

◆ init()

void blender::gpu::MTLStorageBuf::init ( )

Definition at line 111 of file mtl_storage_buffer.mm.

References blender::gpu::MTLBufferPool::allocate(), BLI_assert, blender::gpu::MTLContext::device, blender::gpu::MTLContext::get(), blender::gpu::MTLContext::get_global_memory_manager(), blender::gpu::MTLBuffer::get_metal_buffer(), GPU_USAGE_DEVICE_ONLY, metal_buffer_, blender::gpu::StorageBuf::name_, blender::gpu::MTLBuffer::set_label(), blender::gpu::StorageBuf::size_in_bytes_, and UNUSED_VARS_NDEBUG.

Referenced by async_flush_to_host(), bind(), clear(), copy_sub(), read(), and update().

◆ read()

void blender::gpu::MTLStorageBuf::read ( void * data)
overridevirtual

Read storage buffer contents via staging buffer.

Direct storage buffer read.

Implements blender::gpu::StorageBuf.

Definition at line 377 of file mtl_storage_buffer.mm.

References blender::gpu::MTLBufferPool::allocate(), BLI_assert, BLI_time_sleep_ms(), blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder(), blender::gpu::MTLBuffer::free(), blender::gpu::MTLContext::get(), blender::gpu::MTLContext::get_global_memory_manager(), blender::gpu::MTLBuffer::get_host_ptr(), blender::gpu::MTLBuffer::get_metal_buffer(), blender::gpu::MTLBuffer::get_resource_options(), GPU_finish(), GPU_USAGE_DEVICE_ONLY, init(), blender::gpu::MTLContext::main_command_buffer, metal_buffer_, MTL_LOG_WARNING, size(), and blender::gpu::StorageBuf::size_in_bytes_.

◆ sync_as_indirect_buffer()

void blender::gpu::MTLStorageBuf::sync_as_indirect_buffer ( )
inlineoverridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 79 of file mtl_storage_buffer.hh.

◆ unbind()

void blender::gpu::MTLStorageBuf::unbind ( )
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 246 of file mtl_storage_buffer.mm.

References blender::gpu::MTLStorageBufferBinding::bound, G, G_DEBUG_GPU, blender::gpu::MTLContext::pipeline_state, blender::gpu::MTLStorageBufferBinding::ssbo, and blender::gpu::MTLContextGlobalShaderPipelineState::ssbo_bindings.

Referenced by blender::gpu::MTLContext::~MTLContext().

◆ update()

void blender::gpu::MTLStorageBuf::update ( const void * data)
overridevirtual

Implements blender::gpu::StorageBuf.

Definition at line 138 of file mtl_storage_buffer.mm.

References blender::gpu::MTLBufferPool::allocate(), BLI_assert, blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder(), blender::gpu::MTLBuffer::flush_range(), blender::gpu::MTLBuffer::free(), blender::gpu::MTLContext::get(), blender::gpu::MTLContext::get_global_memory_manager(), blender::gpu::MTLBuffer::get_host_ptr(), blender::gpu::MTLBuffer::get_metal_buffer(), blender::gpu::MTLBuffer::get_resource_options(), get_size(), GPU_USAGE_DEVICE_ONLY, init(), blender::gpu::MTLContext::main_command_buffer, metal_buffer_, size(), and blender::gpu::StorageBuf::size_in_bytes_.

Referenced by bind().

Member Data Documentation

◆ index_buffer_

MTLIndexBuf* blender::gpu::MTLStorageBuf::index_buffer_

Definition at line 45 of file mtl_storage_buffer.hh.

Referenced by get_metal_buffer(), and MTLStorageBuf().

◆ metal_buffer_

gpu::MTLBuffer* blender::gpu::MTLStorageBuf::metal_buffer_

Own allocation.

Definition at line 41 of file mtl_storage_buffer.hh.

Referenced by async_flush_to_host(), bind(), clear(), copy_sub(), get_metal_buffer(), init(), MTLStorageBuf(), read(), update(), and ~MTLStorageBuf().

◆ texture_

gpu::MTLTexture* blender::gpu::MTLStorageBuf::texture_

Definition at line 46 of file mtl_storage_buffer.hh.

Referenced by get_metal_buffer(), and MTLStorageBuf().

◆ uniform_buffer_

MTLUniformBuf* blender::gpu::MTLStorageBuf::uniform_buffer_

Definition at line 43 of file mtl_storage_buffer.hh.

Referenced by get_metal_buffer(), and MTLStorageBuf().

◆ vertex_buffer_

MTLVertBuf* blender::gpu::MTLStorageBuf::vertex_buffer_

Definition at line 44 of file mtl_storage_buffer.hh.

Referenced by get_metal_buffer(), and MTLStorageBuf().

The documentation for this class was generated from the following files:
Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0