Struct Library 

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

A collection of compiled shader functions.

C++ equivalent: MTL::Library

Implementations

impl Library

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

Create a Library from a raw pointer.

Safety

The pointer must be a valid Metal library object.

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

Get the raw pointer to the library.

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

Get the label for this library.

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

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

Set the label for this library.

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

pub fn device(&self) -> Device

Get the device that created this library.

C++ equivalent: Device* device() const

pub fn library_type(&self) -> LibraryType

Get the library type.

C++ equivalent: LibraryType type() const

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

Get the install name (for dynamic libraries).

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

pub fn new_function_with_name(&self, name: &str) -> Option<Function>

Get a function by name.

C++ equivalent: Function* newFunction(const NS::String* name)

pub unsafe fn new_function_with_name_and_constants( &self, name: &str, constant_values: *const c_void, ) -> Result<Function, Error>

Get a function by name with constant values.

C++ equivalent: Function* newFunction(const NS::String*, const FunctionConstantValues*, NS::Error**)

Safety

The constant_values pointer must be valid if not null.

pub fn function_names(&self) -> Vec<String>

Get all function names in the library.

C++ equivalent: NS::Array* functionNames() const

pub fn new_function_with_descriptor( &self, descriptor: &FunctionDescriptor, ) -> Result<Function, Error>

Create a function with a descriptor.

C++ equivalent: Function* newFunction(const FunctionDescriptor*, NS::Error**)

pub fn new_intersection_function( &self, descriptor: &IntersectionFunctionDescriptor, ) -> Result<Function, Error>

Create an intersection function with a descriptor.

C++ equivalent: Function* newIntersectionFunction(const IntersectionFunctionDescriptor*, NS::Error**)

pub fn reflection_for_function(&self, name: &str) -> Option<FunctionReflection>

Get reflection information for a function by name.

C++ equivalent: FunctionReflection* reflectionForFunction(const NS::String*)

pub fn new_function_with_name_and_constants_async<F>( &self, name: &str, constant_values: &FunctionConstantValues, completion_handler: F, )

where F: Fn(Option<Function>, Option<Error>) + Send + 'static,

Create a function with constant values asynchronously.

C++ equivalent: void newFunction(const NS::String*, const FunctionConstantValues*, void (^)(Function*, Error*))

pub fn new_function_with_descriptor_async<F>( &self, descriptor: &FunctionDescriptor, completion_handler: F, )

where F: Fn(Option<Function>, Option<Error>) + Send + 'static,

Create a function with a descriptor asynchronously.

C++ equivalent: void newFunction(const FunctionDescriptor*, void (^)(Function*, Error*))

pub fn new_intersection_function_async<F>( &self, descriptor: &IntersectionFunctionDescriptor, completion_handler: F, )

where F: Fn(Option<Function>, Option<Error>) + Send + 'static,

Create an intersection function with a descriptor asynchronously.

C++ equivalent: void newIntersectionFunction(const IntersectionFunctionDescriptor*, void (^)(Function*, Error*))

Trait Implementations

impl Clone for Library

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 Library

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

Formats the value using the given formatter.

impl Drop for Library

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for Library

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 Library

impl Sync for Library