Struct Function 

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

A compiled shader function.

C++ equivalent: MTL::Function

Implementations

impl Function

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

Create a Function from a raw pointer.

Safety

The pointer must be a valid Metal function object.

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

Get the raw pointer to the function.

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

Get the label for this function.

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

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

Set the label for this function.

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

pub fn device(&self) -> Device

Get the device that created this function.

C++ equivalent: Device* device() const

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

Get the function name.

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

pub fn function_type(&self) -> FunctionType

Get the function type.

C++ equivalent: FunctionType functionType() const

pub fn patch_type(&self) -> PatchType

Get the patch type (for tessellation shaders).

C++ equivalent: PatchType patchType() const

pub fn patch_control_point_count(&self) -> Integer

Get the patch control point count (for tessellation shaders).

C++ equivalent: NS::Integer patchControlPointCount() const

pub fn options(&self) -> FunctionOptions

Get the function options.

C++ equivalent: FunctionOptions options() const

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

Get the function constants dictionary (raw NSDictionary pointer).

C++ equivalent: NS::Dictionary* functionConstantsDictionary() const

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

Get the stage input attributes (raw NSArray pointer).

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

Returns an array of Attribute objects.

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

Get the vertex attributes (raw NSArray pointer).

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

Returns an array of VertexAttribute objects (for vertex functions).

pub fn new_argument_encoder( &self, buffer_index: UInteger, ) -> Option<ArgumentEncoder>

Create a new argument encoder for the buffer at the specified index.

C++ equivalent: ArgumentEncoder* newArgumentEncoder(NS::UInteger bufferIndex)

pub unsafe fn new_argument_encoder_with_reflection( &self, buffer_index: UInteger, reflection: *mut *mut c_void, ) -> Option<ArgumentEncoder>

Create a new argument encoder with reflection for the buffer at the specified index.

C++ equivalent: ArgumentEncoder* newArgumentEncoder(NS::UInteger bufferIndex, const AutoreleasedArgument* reflection)

Safety

The reflection pointer must be a valid pointer to an Argument pointer, or null.

Trait Implementations

impl Clone for Function

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 Function

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

Formats the value using the given formatter.

impl Drop for Function

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for Function

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 Function

impl Sync for Function