Struct CommandBuffer 

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

A buffer that stores encoded commands for the GPU to execute.

C++ equivalent: MTL::CommandBuffer

Command buffers are transient objects - you create them, encode commands, commit them for execution, and then discard them.

Implementations

impl CommandBuffer

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

Create a CommandBuffer from a raw pointer.

Safety

The pointer must be a valid Metal command buffer object.

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

Get the raw pointer to the command buffer.

pub fn commit(&self)

Commit the command buffer for execution.

After calling this, you cannot encode any more commands into the buffer.

C++ equivalent: void commit()

pub fn wait_until_completed(&self)

Block until the command buffer completes execution.

C++ equivalent: void waitUntilCompleted()

pub fn wait_until_scheduled(&self)

Block until the command buffer is scheduled for execution.

C++ equivalent: void waitUntilScheduled()

pub fn enqueue(&self)

Enqueue the command buffer for execution.

C++ equivalent: void enqueue()

pub fn status(&self) -> CommandBufferStatus

Get the current status of the command buffer.

C++ equivalent: CommandBufferStatus status() const

pub fn error(&self) -> Option<Error>

Get the error if the command buffer failed.

C++ equivalent: NS::Error* error() const

pub fn gpu_start_time(&self) -> TimeInterval

Get the time when the GPU started executing the command buffer.

C++ equivalent: CFTimeInterval GPUStartTime() const

pub fn gpu_end_time(&self) -> TimeInterval

Get the time when the GPU finished executing the command buffer.

C++ equivalent: CFTimeInterval GPUEndTime() const

pub fn kernel_start_time(&self) -> TimeInterval

Get the time when the kernel started executing the command buffer.

C++ equivalent: CFTimeInterval kernelStartTime() const

pub fn kernel_end_time(&self) -> TimeInterval

Get the time when the kernel finished executing the command buffer.

C++ equivalent: CFTimeInterval kernelEndTime() const

pub fn retained_references(&self) -> bool

Check if the command buffer retains resources.

C++ equivalent: bool retainedReferences() const

pub fn add_completed_handler<F>(&self, handler: F)

where F: Fn(&CommandBuffer) + Send + 'static,

Add a handler to be called when the command buffer completes.

C++ equivalent: void addCompletedHandler(void (^)(CommandBuffer*))

pub fn add_scheduled_handler<F>(&self, handler: F)

where F: Fn(&CommandBuffer) + Send + 'static,

Add a handler to be called when the command buffer is scheduled.

C++ equivalent: void addScheduledHandler(void (^)(CommandBuffer*))

pub unsafe fn present_drawable(&self, drawable: *const c_void)

Schedule a drawable for presentation at the earliest opportunity.

C++ equivalent: void presentDrawable(Drawable*)

Safety

The drawable pointer must be valid.

pub unsafe fn present_drawable_at_time( &self, drawable: *const c_void, time: TimeInterval, )

Schedule a drawable for presentation at a specific time.

C++ equivalent: void presentDrawable(Drawable*, CFTimeInterval)

Safety

The drawable pointer must be valid.

pub unsafe fn present_drawable_after_minimum_duration( &self, drawable: *const c_void, duration: TimeInterval, )

Schedule a drawable for presentation after a minimum duration.

C++ equivalent: void presentDrawableAfterMinimumDuration(Drawable*, CFTimeInterval)

Safety

The drawable pointer must be valid.

pub fn encode_signal_event(&self, event: &Event, value: u64)

Encode a signal for an event.

C++ equivalent: void encodeSignalEvent(const Event*, uint64_t value)

pub fn encode_wait_for_event(&self, event: &Event, value: u64)

Encode a wait for an event.

C++ equivalent: void encodeWait(const Event*, uint64_t value)

pub unsafe fn use_residency_set(&self, residency_set: *const c_void)

Use a residency set for this command buffer.

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

Safety

The residency_set pointer must be valid.

pub unsafe fn use_residency_sets( &self, residency_sets: *const *const c_void, count: UInteger, )

Use multiple residency sets for this command buffer.

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

Safety

The residency_sets pointer must be valid and point to count valid pointers.

pub fn error_options(&self) -> CommandBufferErrorOption

Get the error options for this command buffer.

C++ equivalent: CommandBufferErrorOption errorOptions() const

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

Create a blit command encoder.

C++ equivalent: BlitCommandEncoder* blitCommandEncoder()

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub unsafe fn blit_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create a blit command encoder with a descriptor.

C++ equivalent: BlitCommandEncoder* blitCommandEncoder(const BlitPassDescriptor*)

Safety

The descriptor pointer must be valid.

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

Create a compute command encoder.

C++ equivalent: ComputeCommandEncoder* computeCommandEncoder()

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub fn compute_command_encoder_with_dispatch_type( &self, dispatch_type: DispatchType, ) -> *mut c_void

Create a compute command encoder with a dispatch type.

C++ equivalent: ComputeCommandEncoder* computeCommandEncoder(DispatchType)

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub unsafe fn compute_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create a compute command encoder with a descriptor.

C++ equivalent: ComputeCommandEncoder* computeCommandEncoder(const ComputePassDescriptor*)

Safety

The descriptor pointer must be valid.

pub unsafe fn render_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create a render command encoder.

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

Safety

The descriptor pointer must be valid.

pub unsafe fn parallel_render_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create a parallel render command encoder.

C++ equivalent: ParallelRenderCommandEncoder* parallelRenderCommandEncoder(const RenderPassDescriptor*)

Safety

The descriptor pointer must be valid.

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

Create a resource state command encoder.

C++ equivalent: ResourceStateCommandEncoder* resourceStateCommandEncoder()

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub unsafe fn resource_state_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create a resource state command encoder with a descriptor.

C++ equivalent: ResourceStateCommandEncoder* resourceStateCommandEncoder(const ResourceStatePassDescriptor*)

Safety

The descriptor pointer must be valid.

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

Create an acceleration structure command encoder.

C++ equivalent: AccelerationStructureCommandEncoder* accelerationStructureCommandEncoder()

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub unsafe fn acceleration_structure_command_encoder_with_descriptor( &self, descriptor: *const c_void, ) -> *mut c_void

Create an acceleration structure command encoder with a descriptor.

C++ equivalent: AccelerationStructureCommandEncoder* accelerationStructureCommandEncoder(const AccelerationStructurePassDescriptor*)

Safety

The descriptor pointer must be valid.

pub fn render_command_encoder( &self, descriptor: &RenderPassDescriptor, ) -> *mut c_void

Create a render command encoder with a typed descriptor.

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

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub fn parallel_render_command_encoder( &self, descriptor: &RenderPassDescriptor, ) -> *mut c_void

Create a parallel render command encoder with a typed descriptor.

C++ equivalent: ParallelRenderCommandEncoder* parallelRenderCommandEncoder(const RenderPassDescriptor*)

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub fn compute_command_encoder_with_pass_descriptor( &self, descriptor: &ComputePassDescriptor, ) -> *mut c_void

Create a compute command encoder with a typed descriptor.

C++ equivalent: ComputeCommandEncoder* computeCommandEncoder(const ComputePassDescriptor*)

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

pub fn blit_command_encoder_with_pass_descriptor( &self, descriptor: &BlitPassDescriptor, ) -> *mut c_void

Create a blit command encoder with a typed descriptor.

C++ equivalent: BlitCommandEncoder* blitCommandEncoder(const BlitPassDescriptor*)

Returns a raw pointer to the encoder. The caller is responsible for ending encoding.

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

Get the label for this command buffer.

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

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

Set the label for this command buffer.

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

pub fn device(&self) -> Device

Get the device that created this command buffer.

C++ equivalent: Device* device() const

pub fn command_queue(&self) -> CommandQueue

Get the command queue that created this command buffer.

C++ equivalent: CommandQueue* commandQueue() const

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

Push a debug group.

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

pub fn pop_debug_group(&self)

Pop a debug group.

C++ equivalent: void popDebugGroup()

pub fn logs(&self) -> Option<LogContainer>

Get the log container for this command buffer.

C++ equivalent: LogContainer* logs() const

Returns a container of function logs generated during command buffer execution. The log container conforms to FastEnumeration and can be iterated.

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