Struct CommandQueue 

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

A queue that organizes the order of command buffer execution.

C++ equivalent: MTL::CommandQueue

You typically create a command queue early in your app’s lifecycle and reuse it throughout the app. Command buffers created from the same queue are guaranteed to execute in the order they are committed.

Implementations

impl CommandQueue

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

Create a CommandQueue from a raw pointer.

Safety

The pointer must be a valid Metal command queue object.

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

Get the raw pointer to the command queue.

pub fn command_buffer(&self) -> Option<CommandBuffer>

Create a new command buffer.

C++ equivalent: CommandBuffer* commandBuffer()

pub fn command_buffer_with_unretained_references(&self) -> Option<CommandBuffer>

Create a new command buffer with an unretained reference.

The returned command buffer is autoreleased and will be deallocated unless you explicitly retain it.

C++ equivalent: CommandBuffer* commandBufferWithUnretainedReferences()

pub unsafe fn command_buffer_with_descriptor_ptr( &self, descriptor: *const c_void, ) -> Option<CommandBuffer>

Create a new command buffer with a descriptor (raw pointer version).

C++ equivalent: CommandBuffer* commandBuffer(const CommandBufferDescriptor*)

Safety

The descriptor pointer must be valid.

pub fn command_buffer_with_descriptor( &self, descriptor: &CommandBufferDescriptor, ) -> Option<CommandBuffer>

Create a new command buffer with a typed descriptor.

C++ equivalent: CommandBuffer* commandBuffer(const CommandBufferDescriptor*)

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

Get the label for this command queue.

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

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

Set the label for this command queue.

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

pub fn device(&self) -> Device

Get the device that created this command queue.

C++ equivalent: Device* device() const

pub fn insert_debug_capture_boundary(&self)

Insert a debug capture boundary.

C++ equivalent: void insertDebugCaptureBoundary()

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

Add a residency set to the command queue.

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

Safety

The residency_set pointer must be valid.

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

Add multiple residency sets to the command queue.

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

Safety

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

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

Remove a residency set from the command queue.

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

Safety

The residency_set pointer must be valid.

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

Remove multiple residency sets from the command queue.

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

Safety

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

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

Wait for an event to reach a specific value.

C++ equivalent: void wait(const MTL::Event* event, uint64_t value)

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

Wait for a drawable to become available.

C++ equivalent: void wait(const MTL::Drawable* drawable)

Safety

The drawable pointer must be valid.

Trait Implementations

impl Clone for CommandQueue

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 CommandQueue

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

Formats the value using the given formatter.

impl Drop for CommandQueue

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for CommandQueue

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 CommandQueue

impl Sync for CommandQueue