Skip to main content

CommandEncoder

Struct CommandEncoder 

Source
pub struct CommandEncoder(/* private fields */);
Expand description

Base command encoder for MTL4.

C++ equivalent: MTL4::CommandEncoder

CommandEncoder provides the base interface for all MTL4 command encoders, including barrier operations, fence management, and debug groups.

Implementations§

Source§

impl CommandEncoder

Source

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

Create a CommandEncoder from a raw pointer.

Source

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

Get the raw pointer.

Source

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

Get the device.

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

Source

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

Get the label.

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

Source

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

Set the label.

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

Source

pub fn barrier(&self)

Insert a barrier for all resources.

C++ equivalent: void barrier()

Source

pub fn barrier_buffer( &self, buffer: *const c_void, visibility: VisibilityOptions, )

Insert a barrier for a specific buffer.

C++ equivalent: void barrier(const MTL::Buffer*, MTL4::VisibilityOptions)

Source

pub fn barrier_buffers( &self, buffers: *const *const c_void, count: UInteger, visibility: VisibilityOptions, )

Insert a barrier for multiple buffers.

C++ equivalent: void barrier(const MTL::Buffer* const*, NS::UInteger, MTL4::VisibilityOptions)

Source

pub fn barrier_texture( &self, texture: *const c_void, visibility: VisibilityOptions, )

Insert a barrier for a specific texture.

C++ equivalent: void barrier(const MTL::Texture*, MTL4::VisibilityOptions)

Source

pub fn barrier_textures( &self, textures: *const *const c_void, count: UInteger, visibility: VisibilityOptions, )

Insert a barrier for multiple textures.

C++ equivalent: void barrier(const MTL::Texture* const*, NS::UInteger, MTL4::VisibilityOptions)

Source

pub fn update_fence(&self, fence: *const c_void)

Update a fence.

C++ equivalent: void updateFence(const MTL::Fence*)

Source

pub fn wait_for_fence(&self, fence: *const c_void)

Wait for a fence.

C++ equivalent: void waitForFence(const MTL::Fence*)

Source

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

Push a debug group.

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

Source

pub fn pop_debug_group(&self)

Pop a debug group.

C++ equivalent: void popDebugGroup()

Source

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

Insert a debug signpost.

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

Source

pub fn end_encoding(&self)

End encoding.

C++ equivalent: void endEncoding()

Trait Implementations§

Source§

impl Clone for CommandEncoder

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CommandEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for CommandEncoder

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for CommandEncoder

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

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

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for CommandEncoder

Source§

impl Sync for CommandEncoder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.