Struct FunctionDescriptor 

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

Descriptor for creating specialized functions.

C++ equivalent: MTL::FunctionDescriptor

Used to create specialized functions from a library.

Implementations

impl FunctionDescriptor

pub fn alloc() -> Option<Self>

Allocate a new function descriptor.

C++ equivalent: static FunctionDescriptor* alloc()

pub fn init(&self) -> Option<Self>

Initialize an allocated function descriptor.

C++ equivalent: FunctionDescriptor* init()

pub fn new() -> Option<Self>

Create a new function descriptor.

pub fn function_descriptor() -> Option<Self>

Create a function descriptor using the factory method.

C++ equivalent: static FunctionDescriptor* functionDescriptor()

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal function descriptor object.

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

Get the raw pointer.

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

Get the function name.

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

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

Set the function name.

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

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

Get the specialized name.

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

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

Set the specialized name.

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

pub fn constant_values(&self) -> Option<FunctionConstantValues>

Get the function constant values.

C++ equivalent: FunctionConstantValues* constantValues() const

pub fn set_constant_values(&self, values: Option<&FunctionConstantValues>)

Set the function constant values.

C++ equivalent: void setConstantValues(const FunctionConstantValues*)

pub fn options(&self) -> FunctionOptions

Get the function options.

C++ equivalent: FunctionOptions options() const

pub fn set_options(&self, options: FunctionOptions)

Set the function options.

C++ equivalent: void setOptions(FunctionOptions)

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

Get the binary archives (raw NSArray pointer).

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

pub unsafe fn set_binary_archives_raw(&self, archives: *const c_void)

Set the binary archives.

C++ equivalent: void setBinaryArchives(const NS::Array*)

Safety

The archives pointer must be a valid NSArray of BinaryArchive objects or null.

Trait Implementations

impl Clone for FunctionDescriptor

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 FunctionDescriptor

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

Formats the value using the given formatter.

impl Default for FunctionDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for FunctionDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for FunctionDescriptor

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 FunctionDescriptor

impl Sync for FunctionDescriptor