Skip to main content

Archive

Struct Archive 

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

MTL4 pipeline archive.

C++ equivalent: MTL4::Archive

Archive provides access to pre-compiled pipelines and binary functions, allowing for faster pipeline creation without runtime compilation.

Implementations§

Source§

impl Archive

Source

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

Create an Archive from a raw pointer.

Source

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

Get the raw pointer.

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 new_binary_function( &self, descriptor: &BinaryFunctionDescriptor, ) -> Result<BinaryFunction, Error>

Create a new binary function from the archive.

C++ equivalent: BinaryFunction* newBinaryFunction(const MTL4::BinaryFunctionDescriptor*, NS::Error**)

Source

pub fn new_compute_pipeline_state( &self, descriptor: &ComputePipelineDescriptor, ) -> Result<ComputePipelineState, Error>

Create a new compute pipeline state from the archive.

C++ equivalent: MTL::ComputePipelineState* newComputePipelineState(const MTL4::ComputePipelineDescriptor*, NS::Error**)

Source

pub fn new_compute_pipeline_state_with_dynamic_linking( &self, descriptor: &ComputePipelineDescriptor, dynamic_linking: &PipelineStageDynamicLinkingDescriptor, ) -> Result<ComputePipelineState, Error>

Create a new compute pipeline state with dynamic linking from the archive.

C++ equivalent: MTL::ComputePipelineState* newComputePipelineState(..., dynamicLinkingDescriptor, ...)

Source

pub fn new_render_pipeline_state( &self, descriptor: &PipelineDescriptor, ) -> Result<RenderPipelineState, Error>

Create a new render pipeline state from the archive.

C++ equivalent: MTL::RenderPipelineState* newRenderPipelineState(const MTL4::PipelineDescriptor*, NS::Error**)

Source

pub fn new_render_pipeline_state_with_dynamic_linking( &self, descriptor: &PipelineDescriptor, dynamic_linking: &RenderPipelineDynamicLinkingDescriptor, ) -> Result<RenderPipelineState, Error>

Create a new render pipeline state with dynamic linking from the archive.

C++ equivalent: MTL::RenderPipelineState* newRenderPipelineState(..., dynamicLinkingDescriptor, ...)

Trait Implementations§

Source§

impl Clone for Archive

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 Archive

Source§

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

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

impl Drop for Archive

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for Archive

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 Archive

Source§

impl Sync for Archive

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.