Skip to main content

ComputePipelineDescriptor

Struct ComputePipelineDescriptor 

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

Descriptor for MTL4 compute pipelines.

C++ equivalent: MTL4::ComputePipelineDescriptor

ComputePipelineDescriptor configures the compute function and threadgroup settings for a compute pipeline.

Implementations§

Source§

impl ComputePipelineDescriptor

Source

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

Create a ComputePipelineDescriptor from a raw pointer.

Source

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

Get the raw pointer.

Source

pub fn new() -> Option<Self>

Create a new compute pipeline descriptor.

Source

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

Get the label.

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

Source

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

Set the label.

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

Source

pub fn options(&self) -> Option<PipelineOptions>

Get the pipeline options.

C++ equivalent: PipelineOptions* options() const

Source

pub fn set_options(&self, options: &PipelineOptions)

Set the pipeline options.

C++ equivalent: void setOptions(const MTL4::PipelineOptions*)

Source

pub fn compute_function_descriptor(&self) -> Option<FunctionDescriptor>

Get the compute function descriptor.

C++ equivalent: FunctionDescriptor* computeFunctionDescriptor() const

Source

pub fn set_compute_function_descriptor(&self, descriptor: &FunctionDescriptor)

Set the compute function descriptor.

C++ equivalent: void setComputeFunctionDescriptor(const MTL4::FunctionDescriptor*)

Source

pub fn max_total_threads_per_threadgroup(&self) -> UInteger

Get the maximum total threads per threadgroup.

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

Source

pub fn set_max_total_threads_per_threadgroup(&self, max_threads: UInteger)

Set the maximum total threads per threadgroup.

C++ equivalent: void setMaxTotalThreadsPerThreadgroup(NS::UInteger)

Source

pub fn required_threads_per_threadgroup(&self) -> Size

Get the required threads per threadgroup.

C++ equivalent: MTL::Size requiredThreadsPerThreadgroup() const

Source

pub fn set_required_threads_per_threadgroup(&self, size: Size)

Set the required threads per threadgroup.

C++ equivalent: void setRequiredThreadsPerThreadgroup(MTL::Size)

Source

pub fn static_linking_descriptor(&self) -> Option<StaticLinkingDescriptor>

Get the static linking descriptor.

C++ equivalent: StaticLinkingDescriptor* staticLinkingDescriptor() const

Source

pub fn set_static_linking_descriptor( &self, descriptor: &StaticLinkingDescriptor, )

Set the static linking descriptor.

C++ equivalent: void setStaticLinkingDescriptor(const MTL4::StaticLinkingDescriptor*)

Source

pub fn support_binary_linking(&self) -> bool

Get whether binary linking is supported.

C++ equivalent: bool supportBinaryLinking() const

Source

pub fn set_support_binary_linking(&self, support: bool)

Set whether binary linking is supported.

C++ equivalent: void setSupportBinaryLinking(bool)

Source

pub fn support_indirect_command_buffers( &self, ) -> IndirectCommandBufferSupportState

Get the indirect command buffer support state.

C++ equivalent: IndirectCommandBufferSupportState supportIndirectCommandBuffers() const

Source

pub fn set_support_indirect_command_buffers( &self, state: IndirectCommandBufferSupportState, )

Set the indirect command buffer support state.

C++ equivalent: void setSupportIndirectCommandBuffers(MTL4::IndirectCommandBufferSupportState)

Source

pub fn thread_group_size_is_multiple_of_thread_execution_width(&self) -> bool

Get whether threadgroup size is a multiple of thread execution width.

C++ equivalent: bool threadGroupSizeIsMultipleOfThreadExecutionWidth() const

Source

pub fn set_thread_group_size_is_multiple_of_thread_execution_width( &self, value: bool, )

Set whether threadgroup size is a multiple of thread execution width.

C++ equivalent: void setThreadGroupSizeIsMultipleOfThreadExecutionWidth(bool)

Source

pub fn reset(&self)

Reset the descriptor to its default state.

C++ equivalent: void reset()

Trait Implementations§

Source§

impl Clone for ComputePipelineDescriptor

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 ComputePipelineDescriptor

Source§

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

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

impl Drop for ComputePipelineDescriptor

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Referencing for ComputePipelineDescriptor

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 ComputePipelineDescriptor

Source§

impl Sync for ComputePipelineDescriptor

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.