Struct Argument 

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

Information about a function argument.

C++ equivalent: MTL::Argument

Implementations

impl Argument

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

Create from a raw pointer.

Safety

The pointer must be a valid Metal Argument.

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

Get the raw pointer.

pub fn access(&self) -> BindingAccess

Get the access mode.

C++ equivalent: BindingAccess access() const

pub fn array_length(&self) -> UInteger

Get the array length.

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

pub fn buffer_alignment(&self) -> UInteger

Get the buffer alignment.

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

pub fn buffer_data_size(&self) -> UInteger

Get the buffer data size.

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

pub fn buffer_data_type(&self) -> DataType

Get the buffer data type.

C++ equivalent: DataType bufferDataType() const

pub fn buffer_pointer_type(&self) -> Option<PointerType>

Get the buffer pointer type.

C++ equivalent: PointerType* bufferPointerType() const

pub fn buffer_struct_type(&self) -> Option<StructType>

Get the buffer struct type.

C++ equivalent: StructType* bufferStructType() const

pub fn index(&self) -> UInteger

Get the index.

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

pub fn is_active(&self) -> bool

Check if the argument is active.

C++ equivalent: bool isActive() const

pub fn is_depth_texture(&self) -> bool

Check if this is a depth texture.

C++ equivalent: bool isDepthTexture() const

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

Get the name.

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

pub fn texture_data_type(&self) -> DataType

Get the texture data type.

C++ equivalent: DataType textureDataType() const

pub fn texture_type(&self) -> TextureType

Get the texture type.

C++ equivalent: TextureType textureType() const

pub fn threadgroup_memory_alignment(&self) -> UInteger

Get the threadgroup memory alignment.

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

pub fn threadgroup_memory_data_size(&self) -> UInteger

Get the threadgroup memory data size.

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

pub fn argument_type(&self) -> ArgumentType

Get the argument type.

C++ equivalent: ArgumentType type() const

pub fn active(&self) -> bool

👎Deprecated: Use is_active instead

Check if the argument is active (deprecated).

C++ equivalent: bool active() const

Trait Implementations

impl Clone for Argument

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 Argument

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for Argument

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 Argument

impl Sync for Argument