Struct CommandBuffer 

pub struct CommandBuffer(/* private fields */);

MTL4 command buffer for recording GPU commands.

C++ equivalent: MTL4::CommandBuffer

CommandBuffer in Metal 4 provides explicit control over command recording with an allocator-based memory model.

Implementations

impl CommandBuffer

pub unsafe fn from_raw(ptr: *mut c_void) -> Option<Self>

Create a CommandBuffer from a raw pointer.

pub fn as_raw(&self) -> *mut c_void

Get the raw pointer.

pub fn device(&self) -> Option<Device>

Get the device.

C++ equivalent: MTL::Device* device() const

pub fn label(&self) -> Option<String>

Get the label.

C++ equivalent: NS::String* label() const

pub fn set_label(&self, label: &str)

Set the label.

C++ equivalent: void setLabel(const NS::String* label)

pub fn begin_command_buffer(&self, allocator: &CommandAllocator)

Begin recording commands with an allocator.

C++ equivalent: void beginCommandBuffer(const MTL4::CommandAllocator* allocator)

pub fn begin_command_buffer_with_options( &self, allocator: &CommandAllocator, options: &CommandBufferOptions, )

Begin recording commands with an allocator and options.

C++ equivalent: void beginCommandBuffer(const MTL4::CommandAllocator*, const MTL4::CommandBufferOptions*)

pub fn end_command_buffer(&self)

End recording commands.

C++ equivalent: void endCommandBuffer()

pub fn use_residency_set(&self, residency_set: &ResidencySet)

Use a residency set.

C++ equivalent: void useResidencySet(const MTL::ResidencySet* residencySet)

pub fn use_residency_sets(&self, residency_sets: &[&ResidencySet])

Use multiple residency sets.

C++ equivalent: void useResidencySets(const MTL::ResidencySet* const[], NS::UInteger count)

pub fn push_debug_group(&self, name: &str)

Push a debug group.

C++ equivalent: void pushDebugGroup(const NS::String* string)

pub fn pop_debug_group(&self)

Pop the current debug group.

C++ equivalent: void popDebugGroup()

pub fn compute_command_encoder(&self) -> Option<ComputeCommandEncoder>

Create a compute command encoder.

C++ equivalent: ComputeCommandEncoder* computeCommandEncoder()

pub fn render_command_encoder( &self, descriptor: &RenderPassDescriptor, ) -> Option<RenderCommandEncoder>

Create a render command encoder with the specified render pass descriptor.

C++ equivalent: RenderCommandEncoder* renderCommandEncoder(const RenderPassDescriptor*)

pub fn machine_learning_command_encoder( &self, ) -> Option<MachineLearningCommandEncoder>

Create a machine learning command encoder.

C++ equivalent: MachineLearningCommandEncoder* machineLearningCommandEncoder()

pub fn resolve_counter_heap( &self, counter_heap: *const c_void, range_location: UInteger, range_length: UInteger, buffer_range: BufferRange, fence_to_wait: *const c_void, fence_to_update: *const c_void, )

Resolve counter heap data into a buffer.

C++ equivalent: void resolveCounterHeap(const MTL4::CounterHeap*, NS::Range, const MTL4::BufferRange, const MTL::Fence*, const MTL::Fence*)

pub fn write_timestamp_into_heap( &self, counter_heap: *const c_void, index: UInteger, )

Write a timestamp into a counter heap.

C++ equivalent: void writeTimestampIntoHeap(const MTL4::CounterHeap*, NS::UInteger)

Trait Implementations

impl Clone for CommandBuffer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CommandBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for CommandBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for CommandBuffer

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.

fn retain(&self) -> Self

where Self: Clone,

Retain the object, incrementing its reference count.

fn release(&self)

Release the object, decrementing its reference count.

fn autorelease(&self) -> Self

where Self: Clone,

Autorelease the object.

fn retain_count(&self) -> usize

Get the retain count of the object.

impl Send for CommandBuffer

impl Sync for CommandBuffer