Blender V4.5
Public Member Functions | Static Public Attributes | Friends | List of all members
blender::gpu::MTLCommandBufferManager Class Reference

#include <mtl_context.hh>

Public Member Functions

 MTLCommandBufferManager (MTLContext &context)
 
MTLRenderPassState & get_render_pass_state ()
 
MTLComputeState & get_compute_state ()
 
void inc_active_command_buffer_count ()
 
void dec_active_command_buffer_count ()
 
int get_active_command_buffer_count ()
 
void wait_until_active_command_buffers_complete ()
 
Render Command Encoder Utility and management functions.
bool is_inside_render_pass ()
 
bool is_inside_blit ()
 
bool is_inside_compute ()
 
id< MTLRenderCommandEncoder > get_active_render_command_encoder ()
 
id< MTLBlitCommandEncoder > get_active_blit_command_encoder ()
 
id< MTLComputeCommandEncoder > get_active_compute_command_encoder ()
 
MTLFrameBuffer * get_active_framebuffer ()
 
bool end_active_command_encoder (bool retain_framebuffers=false)
 
id< MTLRenderCommandEncoder > ensure_begin_render_command_encoder (MTLFrameBuffer *ctx_framebuffer, bool force_begin, bool *r_new_pass)
 
id< MTLBlitCommandEncoder > ensure_begin_blit_encoder ()
 
id< MTLComputeCommandEncoder > ensure_begin_compute_encoder ()
 
Command buffer heuristics.
void register_draw_counters (int vertex_submission)
 
void reset_counters ()
 
bool do_break_submission ()
 

Static Public Attributes

static volatile std::atomic< int > num_active_cmd_bufs_in_system = 0
 

Friends

class MTLContext
 

MTLCommandBuffer initialization and render coordination.

void prepare (bool supports_render=true)
 
bool submit (bool wait)
 

Command buffer debugging.

bool insert_memory_barrier (eGPUBarrier barrier_bits, eGPUStageBarrierBits before_stages, eGPUStageBarrierBits after_stages)
 
void encode_signal_event (id< MTLEvent > event, uint64_t value)
 
void encode_wait_for_event (id< MTLEvent > event, uint64_t value)
 
void push_debug_group (const char *name, int index)
 
void pop_debug_group ()
 

Detailed Description

Definition at line 545 of file mtl_context.hh.

Constructor & Destructor Documentation

◆ MTLCommandBufferManager()

blender::gpu::MTLCommandBufferManager::MTLCommandBufferManager ( MTLContext & context)
inline

Definition at line 597 of file mtl_context.hh.

Member Function Documentation

◆ dec_active_command_buffer_count()

void blender::gpu::MTLCommandBufferManager::dec_active_command_buffer_count ( )
inline

Definition at line 661 of file mtl_context.hh.

References BLI_assert, and num_active_cmd_bufs_in_system.

Referenced by blender::gpu::present(), and submit().

◆ do_break_submission()

bool blender::gpu::MTLCommandBufferManager::do_break_submission ( )

Definition at line 479 of file mtl_command_buffer.mm.

References GPU_DEVICE_ATI, GPU_DEVICE_INTEL, GPU_DRIVER_ANY, GPU_OS_ANY, and GPU_type_matches().

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

◆ encode_signal_event()

void blender::gpu::MTLCommandBufferManager::encode_signal_event ( id< MTLEvent > event,
uint64_t value )

Definition at line 666 of file mtl_command_buffer.mm.

References BLI_assert, end_active_command_encoder(), and value.

Referenced by blender::gpu::MTLStorageBuf::async_flush_to_host(), and blender::gpu::MTLFence::signal().

◆ encode_wait_for_event()

void blender::gpu::MTLCommandBufferManager::encode_wait_for_event ( id< MTLEvent > event,
uint64_t value )

Definition at line 676 of file mtl_command_buffer.mm.

References BLI_assert, end_active_command_encoder(), and value.

Referenced by blender::gpu::MTLFence::wait().

◆ end_active_command_encoder()

bool blender::gpu::MTLCommandBufferManager::end_active_command_encoder ( bool retain_framebuffers = false)

Definition at line 232 of file mtl_command_buffer.mm.

References BLI_assert.

Referenced by encode_signal_event(), encode_wait_for_event(), ensure_begin_blit_encoder(), ensure_begin_compute_encoder(), ensure_begin_render_command_encoder(), insert_memory_barrier(), pop_debug_group(), push_debug_group(), submit(), blender::gpu::MTLFrameBuffer::subpass_transition_impl(), and blender::gpu::MTLFrameBuffer::~MTLFrameBuffer().

◆ ensure_begin_blit_encoder()

id< MTLBlitCommandEncoder > blender::gpu::MTLCommandBufferManager::ensure_begin_blit_encoder ( )

Definition at line 374 of file mtl_command_buffer.mm.

References BLI_assert, end_active_command_encoder(), G, and G_DEBUG_GPU.

Referenced by blender::gpu::MTLStorageBuf::async_flush_to_host(), blender::gpu::MTLVertBuf::bind(), blender::gpu::MTLFrameBuffer::blit(), blender::gpu::MTLStorageBuf::clear(), blender::gpu::MTLTexture::clear(), blender::gpu::MTLStorageBuf::copy_sub(), blender::gpu::MTLTexture::copy_to(), blender::gpu::MTLTexture::generate_mipmap(), blender::gpu::MTLQueryPool::get_occlusion_result(), blender::gpu::MTLIndexBuf::read(), blender::gpu::MTLStorageBuf::read(), blender::gpu::MTLVertBuf::read(), blender::gpu::MTLStorageBuf::update(), blender::gpu::MTLIndexBuf::update_sub(), blender::gpu::MTLTexture::update_sub(), blender::gpu::MTLTexture::update_sub(), and blender::gpu::MTLVertBuf::update_sub().

◆ ensure_begin_compute_encoder()

id< MTLComputeCommandEncoder > blender::gpu::MTLCommandBufferManager::ensure_begin_compute_encoder ( )

Definition at line 413 of file mtl_command_buffer.mm.

References BLI_assert, end_active_command_encoder(), G, G_DEBUG_GPU, and blender::gpu::MTLComputeState::reset_state().

Referenced by blender::gpu::MTLStorageBuf::clear(), blender::gpu::MTLTexture::clear(), blender::gpu::MTLContext::compute_dispatch(), blender::gpu::MTLContext::compute_dispatch_indirect(), and blender::gpu::MTLTexture::update_sub().

◆ ensure_begin_render_command_encoder()

id< MTLRenderCommandEncoder > blender::gpu::MTLCommandBufferManager::ensure_begin_render_command_encoder ( MTLFrameBuffer * ctx_framebuffer,
bool force_begin,
bool * r_new_pass )

Definition at line 292 of file mtl_command_buffer.mm.

References blender::gpu::MTLFrameBuffer::apply_state(), blender::gpu::MTLFrameBuffer::bake_render_pass_descriptor(), BLI_assert, blender::gpu::MTLContext::clear_visibility_dirty(), end_active_command_encoder(), G, G_DEBUG_GPU, blender::gpu::MTLBuffer::get_metal_buffer(), blender::gpu::MTLFrameBuffer::get_pending_clear(), blender::gpu::MTLContext::get_visibility_buffer(), blender::gpu::MTLFrameBuffer::mark_cleared(), blender::gpu::FrameBuffer::name_get(), and blender::gpu::MTLRenderPassState::reset_state().

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

◆ get_active_blit_command_encoder()

id< MTLBlitCommandEncoder > blender::gpu::MTLCommandBufferManager::get_active_blit_command_encoder ( )

Definition at line 209 of file mtl_command_buffer.mm.

◆ get_active_command_buffer_count()

int blender::gpu::MTLCommandBufferManager::get_active_command_buffer_count ( )
inline

Definition at line 668 of file mtl_context.hh.

Referenced by wait_until_active_command_buffers_complete().

◆ get_active_compute_command_encoder()

id< MTLComputeCommandEncoder > blender::gpu::MTLCommandBufferManager::get_active_compute_command_encoder ( )

Definition at line 215 of file mtl_command_buffer.mm.

Referenced by blender::gpu::MTLComputeState::bind_compute_buffer(), blender::gpu::MTLComputeState::bind_compute_bytes(), blender::gpu::MTLComputeState::bind_compute_sampler(), blender::gpu::MTLComputeState::bind_compute_texture(), blender::gpu::MTLComputeState::bind_pso(), and insert_memory_barrier().

◆ get_active_framebuffer()

MTLFrameBuffer * blender::gpu::MTLCommandBufferManager::get_active_framebuffer ( )

Definition at line 221 of file mtl_command_buffer.mm.

References is_inside_render_pass().

Referenced by blender::gpu::MTLBatch::bind(), blender::gpu::MTLContext::ensure_begin_render_pass(), blender::gpu::MTLContext::ensure_render_pipeline_state(), blender::gpu::MTLRenderPassState::reset_state(), and blender::gpu::MTLFrameBuffer::~MTLFrameBuffer().

◆ get_active_render_command_encoder()

id< MTLRenderCommandEncoder > blender::gpu::MTLCommandBufferManager::get_active_render_command_encoder ( )

Definition at line 203 of file mtl_command_buffer.mm.

Referenced by blender::gpu::MTLQueryPool::begin_query(), blender::gpu::MTLRenderPassState::bind_fragment_buffer(), blender::gpu::MTLRenderPassState::bind_fragment_bytes(), blender::gpu::MTLRenderPassState::bind_fragment_sampler(), blender::gpu::MTLRenderPassState::bind_fragment_texture(), blender::gpu::MTLRenderPassState::bind_vertex_buffer(), blender::gpu::MTLRenderPassState::bind_vertex_bytes(), blender::gpu::MTLRenderPassState::bind_vertex_sampler(), blender::gpu::MTLRenderPassState::bind_vertex_texture(), blender::gpu::MTLQueryPool::end_query(), blender::gpu::MTLContext::ensure_begin_render_pass(), blender::gpu::MTLContext::ensure_depth_stencil_state(), blender::gpu::MTLContext::ensure_render_pipeline_state(), and insert_memory_barrier().

◆ get_compute_state()

MTLComputeState & blender::gpu::MTLCommandBufferManager::get_compute_state ( )
inline

Definition at line 622 of file mtl_context.hh.

References BLI_assert, and is_inside_compute().

Referenced by blender::gpu::MTLStorageBuf::clear(), blender::gpu::MTLTexture::clear(), blender::gpu::MTLContext::compute_dispatch(), blender::gpu::MTLContext::compute_dispatch_indirect(), blender::gpu::MTLContext::ensure_buffer_bindings(), blender::gpu::MTLContext::ensure_texture_bindings(), and blender::gpu::MTLTexture::update_sub().

◆ get_render_pass_state()

MTLRenderPassState & blender::gpu::MTLCommandBufferManager::get_render_pass_state ( )
inline

Definition at line 614 of file mtl_context.hh.

References BLI_assert, and is_inside_render_pass().

Referenced by blender::gpu::MTLBatch::bind(), blender::gpu::MTLImmediate::end(), blender::gpu::MTLContext::ensure_buffer_bindings(), blender::gpu::MTLContext::ensure_depth_stencil_state(), blender::gpu::MTLContext::ensure_render_pipeline_state(), and blender::gpu::MTLContext::ensure_texture_bindings().

◆ inc_active_command_buffer_count()

void blender::gpu::MTLCommandBufferManager::inc_active_command_buffer_count ( )
inline

Definition at line 655 of file mtl_context.hh.

References num_active_cmd_bufs_in_system.

Referenced by blender::gpu::present().

◆ insert_memory_barrier()

bool blender::gpu::MTLCommandBufferManager::insert_memory_barrier ( eGPUBarrier barrier_bits,
eGPUStageBarrierBits before_stages,
eGPUStageBarrierBits after_stages )

Definition at line 579 of file mtl_command_buffer.mm.

References BLI_assert, end_active_command_encoder(), get_active_compute_command_encoder(), get_active_render_command_encoder(), GPU_ARCHITECTURE_TBDR, GPU_BARRIER_BUFFER_UPDATE, GPU_BARRIER_ELEMENT_ARRAY, GPU_BARRIER_SHADER_IMAGE_ACCESS, GPU_BARRIER_SHADER_STORAGE, GPU_BARRIER_STAGE_FRAGMENT, GPU_BARRIER_STAGE_VERTEX, GPU_BARRIER_TEXTURE_FETCH, GPU_BARRIER_UNIFORM, GPU_BARRIER_VERTEX_ATTRIB_ARRAY, and GPU_platform_architecture().

Referenced by blender::gpu::MTLStateManager::issue_barrier().

◆ is_inside_blit()

bool blender::gpu::MTLCommandBufferManager::is_inside_blit ( )

Definition at line 193 of file mtl_command_buffer.mm.

◆ is_inside_compute()

bool blender::gpu::MTLCommandBufferManager::is_inside_compute ( )

Definition at line 198 of file mtl_command_buffer.mm.

Referenced by get_compute_state().

◆ is_inside_render_pass()

bool blender::gpu::MTLCommandBufferManager::is_inside_render_pass ( )

Definition at line 188 of file mtl_command_buffer.mm.

Referenced by blender::gpu::MTLContext::ensure_begin_render_pass(), get_active_framebuffer(), and get_render_pass_state().

◆ pop_debug_group()

void blender::gpu::MTLCommandBufferManager::pop_debug_group ( )

Definition at line 523 of file mtl_command_buffer.mm.

References end_active_command_encoder(), and METAL_DEBUG_CAPTURE_MAX_NESTED_GROUPS.

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

◆ prepare()

void blender::gpu::MTLCommandBufferManager::prepare ( bool supports_render = true)

Definition at line 29 of file mtl_command_buffer.mm.

References blender::gpu::MTLComputeState::reset_state(), and blender::gpu::MTLRenderPassState::reset_state().

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

◆ push_debug_group()

void blender::gpu::MTLCommandBufferManager::push_debug_group ( const char * name,
int index )

Definition at line 505 of file mtl_command_buffer.mm.

References end_active_command_encoder(), and name.

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

◆ register_draw_counters()

void blender::gpu::MTLCommandBufferManager::register_draw_counters ( int vertex_submission)

Definition at line 462 of file mtl_command_buffer.mm.

Referenced by blender::gpu::MTLImmediate::end().

◆ reset_counters()

void blender::gpu::MTLCommandBufferManager::reset_counters ( )

Definition at line 470 of file mtl_command_buffer.mm.

◆ submit()

bool blender::gpu::MTLCommandBufferManager::submit ( bool wait)

Definition at line 89 of file mtl_command_buffer.mm.

References BLI_assert, dec_active_command_buffer_count(), blender::gpu::MTLSafeFreeList::decrement_reference(), end_active_command_encoder(), error(), blender::gpu::MTLScratchBufferManager::flush_active_scratch_buffer(), G, G_DEBUG_GPU, blender::gpu::MTLBackend::get(), blender::gpu::MTLBufferPool::get_current_safe_list(), blender::gpu::MTLContext::get_global_memory_manager(), blender::gpu::MTLSafeFreeList::increment_reference(), blender::gpu::MTLContext::main_command_buffer, GHOST_ContextCGL::max_command_buffer_count, blender::gpu::MTLContext::memory_manager, MTL_LOG_WARNING, num_active_cmd_bufs_in_system, and wait_until_active_command_buffers_complete().

Referenced by blender::gpu::MTLContext::finish(), blender::gpu::MTLContext::flush(), and blender::gpu::MTLTexture::update_sub().

◆ wait_until_active_command_buffers_complete()

void blender::gpu::MTLCommandBufferManager::wait_until_active_command_buffers_complete ( )
inline

Definition at line 673 of file mtl_context.hh.

References get_active_command_buffer_count().

Referenced by submit(), and blender::gpu::MTLContext::~MTLContext().

Friends And Related Symbol Documentation

◆ MTLContext

friend class MTLContext
friend

Definition at line 546 of file mtl_context.hh.

Member Data Documentation

◆ num_active_cmd_bufs_in_system

volatile std::atomic< int > blender::gpu::MTLCommandBufferManager::num_active_cmd_bufs_in_system = 0
static

Definition at line 550 of file mtl_context.hh.

Referenced by dec_active_command_buffer_count(), inc_active_command_buffer_count(), blender::gpu::present(), and submit().

The documentation for this class was generated from the following files:
Generated on Fri Apr 3 2026 06:33:18 for Blender by  doxygen 1.11.0