Struct FunctionConstant 

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

Function constant definition.

C++ equivalent: MTL::FunctionConstant

Contains information about a function constant defined in shader code.

Implementations

impl FunctionConstant

pub fn alloc() -> Option<Self>

Allocate a new function constant.

C++ equivalent: static FunctionConstant* alloc()

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

Initialize an allocated function constant.

C++ equivalent: FunctionConstant* init()

pub fn new() -> Option<Self>

Create a new function constant.

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 constant object.

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

Get the raw pointer.

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

Get the function constant name.

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

pub fn constant_type(&self) -> DataType

Get the function constant data type.

C++ equivalent: DataType type() const

pub fn index(&self) -> UInteger

Get the function constant index.

C++ equivalent: NS::UInteger index() const

pub fn required(&self) -> bool

Check if the function constant is required.

C++ equivalent: bool required() const

Trait Implementations

impl Clone for FunctionConstant

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 FunctionConstant

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

Formats the value using the given formatter.

impl Drop for FunctionConstant

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for FunctionConstant

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 FunctionConstant

impl Sync for FunctionConstant