Struct ComputePipelineDescriptor 

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

Implementations

impl ComputePipelineDescriptor

pub fn alloc() -> Option<Self>

Allocate a new compute pipeline descriptor.

C++ equivalent: static ComputePipelineDescriptor* alloc()

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

Initialize the descriptor.

C++ equivalent: ComputePipelineDescriptor* init()

pub fn new() -> Option<Self>

Create a new compute pipeline descriptor.

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

Create from a raw pointer.

Safety

The pointer must be a valid compute pipeline descriptor object.

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

Get the raw pointer.

pub fn reset(&self)

Reset the descriptor to default values.

C++ equivalent: void reset()

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

Get the label.

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

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

Set the label.

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

pub fn compute_function(&self) -> Option<Function>

Get the compute function.

C++ equivalent: Function* computeFunction() const

pub fn set_compute_function(&self, function: Option<&Function>)

Set the compute function.

C++ equivalent: void setComputeFunction(const MTL::Function* computeFunction)

pub fn max_total_threads_per_threadgroup(&self) -> UInteger

Get the maximum total threads per threadgroup.

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

pub fn set_max_total_threads_per_threadgroup(&self, count: UInteger)

Set the maximum total threads per threadgroup.

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

pub fn required_threads_per_threadgroup(&self) -> Size

Get the required threads per threadgroup.

C++ equivalent: Size requiredThreadsPerThreadgroup() const

pub fn set_required_threads_per_threadgroup(&self, size: Size)

Set the required threads per threadgroup.

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

pub fn thread_group_size_is_multiple_of_thread_execution_width(&self) -> bool

Check if thread group size is multiple of thread execution width.

C++ equivalent: bool threadGroupSizeIsMultipleOfThreadExecutionWidth() const

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

Set thread group size is multiple of thread execution width.

C++ equivalent: void setThreadGroupSizeIsMultipleOfThreadExecutionWidth(bool threadGroupSizeIsMultipleOfThreadExecutionWidth)

pub fn max_call_stack_depth(&self) -> UInteger

Get the maximum call stack depth.

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

pub fn set_max_call_stack_depth(&self, depth: UInteger)

Set the maximum call stack depth.

C++ equivalent: void setMaxCallStackDepth(NS::UInteger maxCallStackDepth)

pub fn support_indirect_command_buffers(&self) -> bool

Check if the pipeline supports indirect command buffers.

C++ equivalent: bool supportIndirectCommandBuffers() const

pub fn set_support_indirect_command_buffers(&self, support: bool)

Set indirect command buffer support.

C++ equivalent: void setSupportIndirectCommandBuffers(bool supportIndirectCommandBuffers)

pub fn support_adding_binary_functions(&self) -> bool

Check if support adding binary functions is enabled.

C++ equivalent: bool supportAddingBinaryFunctions() const

pub fn set_support_adding_binary_functions(&self, support: bool)

Set support adding binary functions.

C++ equivalent: void setSupportAddingBinaryFunctions(bool supportAddingBinaryFunctions)

pub fn shader_validation(&self) -> ShaderValidation

Get the shader validation mode.

C++ equivalent: ShaderValidation shaderValidation() const

pub fn set_shader_validation(&self, validation: ShaderValidation)

Set the shader validation mode.

C++ equivalent: void setShaderValidation(MTL::ShaderValidation shaderValidation)

pub fn buffers(&self) -> Option<PipelineBufferDescriptorArray>

Get the buffer descriptors array.

C++ equivalent: PipelineBufferDescriptorArray* buffers() const

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

Get the stage input descriptor.

C++ equivalent: StageInputOutputDescriptor* stageInputDescriptor() const

pub unsafe fn set_stage_input_descriptor_raw(&self, descriptor: *const c_void)

Set the stage input descriptor.

C++ equivalent: void setStageInputDescriptor(const StageInputOutputDescriptor*)

Safety

The pointer must be a valid StageInputOutputDescriptor object.

pub fn linked_functions(&self) -> Option<LinkedFunctions>

Get the linked functions.

C++ equivalent: LinkedFunctions* linkedFunctions() const

pub fn set_linked_functions(&self, functions: Option<&LinkedFunctions>)

Set the linked functions.

C++ equivalent: void setLinkedFunctions(const LinkedFunctions*)

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

Get the binary archives (raw NSArray pointer).

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

pub unsafe fn set_binary_archives_raw(&self, archives: *const c_void)

Set the binary archives.

C++ equivalent: void setBinaryArchives(const NS::Array*)

Safety

The pointer must be a valid NSArray of BinaryArchive objects.

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

Get the preloaded libraries (raw NSArray pointer).

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

pub unsafe fn set_preloaded_libraries_raw(&self, libraries: *const c_void)

Set the preloaded libraries.

C++ equivalent: void setPreloadedLibraries(const NS::Array*)

Safety

The pointer must be a valid NSArray of DynamicLibrary objects.

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

Get the insert libraries (raw NSArray pointer).

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

pub unsafe fn set_insert_libraries_raw(&self, libraries: *const c_void)

Set the insert libraries.

C++ equivalent: void setInsertLibraries(const NS::Array*)

Safety

The pointer must be a valid NSArray of DynamicLibrary objects.

Trait Implementations

impl Clone for ComputePipelineDescriptor

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 ComputePipelineDescriptor

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

Formats the value using the given formatter.

impl Default for ComputePipelineDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ComputePipelineDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ComputePipelineDescriptor

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 ComputePipelineDescriptor

impl Sync for ComputePipelineDescriptor