Struct BinaryArchive 

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

A binary archive for caching compiled pipeline state.

C++ equivalent: MTL::BinaryArchive

Implementations

impl BinaryArchive

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal BinaryArchive.

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

Get the raw pointer.

pub fn device(&self) -> Device

Get the device that created this archive.

C++ equivalent: Device* device() 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* label)

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

Add compute pipeline functions to the archive.

C++ equivalent: bool addComputePipelineFunctions(const MTL::ComputePipelineDescriptor*, NS::Error**)

pub fn add_render_pipeline_functions( &self, descriptor: &RenderPipelineDescriptor, ) -> Result<(), Error>

Add render pipeline functions to the archive.

C++ equivalent: bool addRenderPipelineFunctions(const MTL::RenderPipelineDescriptor*, NS::Error**)

pub fn add_function( &self, descriptor: *const c_void, library: &Library, ) -> Result<(), Error>

Add a function to the archive.

C++ equivalent: bool addFunction(const MTL::FunctionDescriptor*, const MTL::Library*, NS::Error**)

pub fn add_library_ptr(&self, descriptor: *const c_void) -> Result<(), Error>

Add a stitched library to the archive.

C++ equivalent: bool addLibrary(const MTL::StitchedLibraryDescriptor*, NS::Error**)

pub fn add_mesh_render_pipeline_functions_ptr( &self, descriptor: *const c_void, ) -> Result<(), Error>

Add mesh render pipeline functions to the archive.

C++ equivalent: bool addMeshRenderPipelineFunctions(const MTL::MeshRenderPipelineDescriptor*, NS::Error**)

pub fn add_tile_render_pipeline_functions_ptr( &self, descriptor: *const c_void, ) -> Result<(), Error>

Add tile render pipeline functions to the archive.

C++ equivalent: bool addTileRenderPipelineFunctions(const MTL::TileRenderPipelineDescriptor*, NS::Error**)

pub fn serialize_to_url(&self, url: &Url) -> Result<(), Error>

Serialize the archive to a URL.

C++ equivalent: bool serializeToURL(const NS::URL*, NS::Error**)

Trait Implementations

impl Clone for BinaryArchive

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 BinaryArchive

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for BinaryArchive

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 BinaryArchive

impl Sync for BinaryArchive