Skip to main content

FunctionConstantValues

Struct FunctionConstantValues 

Source
pub struct FunctionConstantValues(/* private fields */);
Expand description

Constant values for specializing a function.

C++ equivalent: MTL::FunctionConstantValues

Function constant values allow you to specialize a function at runtime by providing values for function constants defined in shader code.

Implementations§

Source§

impl FunctionConstantValues

Source

pub fn alloc() -> Option<Self>

Allocate a new function constant values object.

C++ equivalent: static FunctionConstantValues* alloc()

Source

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

Initialize an allocated function constant values object.

C++ equivalent: FunctionConstantValues* init()

Source

pub fn new() -> Option<Self>

Create a new function constant values object.

Source

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

Source

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

Get the raw pointer.

Source

pub fn reset(&self)

Reset all constant values.

C++ equivalent: void reset()

Source

pub unsafe fn set_constant_value_at_index( &self, value: *const c_void, data_type: DataType, index: UInteger, )

Set a constant value by index.

C++ equivalent: void setConstantValue(const void*, DataType, NS::UInteger)

§Safety

The value pointer must be valid and point to data of the correct type.

Source

pub unsafe fn set_constant_value_with_name( &self, value: *const c_void, data_type: DataType, name: &str, )

Set a constant value by name.

C++ equivalent: void setConstantValue(const void*, DataType, const NS::String*)

§Safety

The value pointer must be valid and point to data of the correct type.

Source

pub unsafe fn set_constant_values( &self, values: *const c_void, data_type: DataType, location: UInteger, length: UInteger, )

Set multiple constant values in a range.

C++ equivalent: void setConstantValues(const void*, DataType, NS::Range)

§Safety

The values pointer must be valid and point to an array of data of the correct type.

Source

pub fn set_bool_at_index(&self, value: bool, index: UInteger)

Set a boolean constant value by index.

Source

pub fn set_int_at_index(&self, value: i32, index: UInteger)

Set an integer constant value by index.

Source

pub fn set_uint_at_index(&self, value: u32, index: UInteger)

Set an unsigned integer constant value by index.

Source

pub fn set_float_at_index(&self, value: f32, index: UInteger)

Set a float constant value by index.

Trait Implementations§

Source§

impl Clone for FunctionConstantValues

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FunctionConstantValues

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FunctionConstantValues

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Drop for FunctionConstantValues

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for FunctionConstantValues

Source§

fn as_ptr(&self) -> *const c_void

Get the raw pointer to the Objective-C object.
Source§

fn as_mut_ptr(&self) -> *mut c_void

Get the raw mutable pointer to the Objective-C object.
Source§

fn retain(&self) -> Self
where Self: Clone,

Retain the object, incrementing its reference count. Read more
Source§

fn release(&self)

Release the object, decrementing its reference count. Read more
Source§

fn autorelease(&self) -> Self
where Self: Clone,

Autorelease the object. Read more
Source§

fn retain_count(&self) -> usize

Get the retain count of the object. Read more
Source§

impl Send for FunctionConstantValues

Source§

impl Sync for FunctionConstantValues

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.