Struct IOCommandBuffer 

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

Command buffer for IO operations.

C++ equivalent: MTL::IOCommandBuffer

Implementations

impl IOCommandBuffer

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal IO command buffer.

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

Get the raw pointer.

pub fn add_barrier(&self)

Add a barrier.

C++ equivalent: void addBarrier()

pub fn commit(&self)

Commit the command buffer.

C++ equivalent: void commit()

pub fn copy_status_to_buffer(&self, buffer: &Buffer, offset: UInteger)

Copy the status to a buffer.

C++ equivalent: void copyStatusToBuffer(const Buffer*, NS::UInteger)

pub fn enqueue(&self)

Enqueue the command buffer.

C++ equivalent: void enqueue()

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

Get the error, if any.

C++ equivalent: NS::Error* error() 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*)

pub fn load_buffer( &self, buffer: &Buffer, offset: UInteger, size: UInteger, source_handle: &IOFileHandle, source_handle_offset: UInteger, )

Load data from a file into a buffer.

C++ equivalent: void loadBuffer(const Buffer*, NS::UInteger, NS::UInteger, const IOFileHandle*, NS::UInteger)

pub unsafe fn load_bytes( &self, pointer: *mut c_void, size: UInteger, source_handle: &IOFileHandle, source_handle_offset: UInteger, )

Load data from a file into memory.

Safety

The pointer must point to valid memory of at least size bytes.

C++ equivalent: void loadBytes(const void*, NS::UInteger, const IOFileHandle*, NS::UInteger)

pub fn load_texture( &self, texture: &Texture, slice: UInteger, level: UInteger, size: Size, source_bytes_per_row: UInteger, source_bytes_per_image: UInteger, destination_origin: Origin, source_handle: &IOFileHandle, source_handle_offset: UInteger, )

Load data from a file into a texture.

C++ equivalent: void loadTexture(const Texture*, NS::UInteger, NS::UInteger, Size, NS::UInteger, NS::UInteger, Origin, const IOFileHandle*, NS::UInteger)

pub fn pop_debug_group(&self)

Pop a debug group.

C++ equivalent: void popDebugGroup()

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

Push a debug group.

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

pub fn signal_event(&self, event: &SharedEvent, value: u64)

Signal a shared event.

C++ equivalent: void signalEvent(const SharedEvent*, uint64_t)

pub fn status(&self) -> IOStatus

Get the status.

C++ equivalent: IOStatus status() const

pub fn try_cancel(&self)

Try to cancel the command buffer.

C++ equivalent: void tryCancel()

pub fn wait(&self, event: &SharedEvent, value: u64)

Wait for a shared event to reach a value.

C++ equivalent: void wait(const SharedEvent*, uint64_t)

pub fn wait_until_completed(&self)

Wait until the command buffer completes.

C++ equivalent: void waitUntilCompleted()

pub unsafe fn add_completed_handler_ptr(&self, block: *const c_void)

Add a completed handler (raw block pointer).

Safety

The block pointer must be a valid Objective-C block.

C++ equivalent: void addCompletedHandler(const IOCommandBufferHandler)

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

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

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

C++ equivalent: void addCompletedHandler(const IOCommandBufferHandler)

The handler is called with a reference to the completed IO command buffer.

Trait Implementations

impl Clone for IOCommandBuffer

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Drop for IOCommandBuffer

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for IOCommandBuffer

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 IOCommandBuffer

impl Sync for IOCommandBuffer