Struct ComputePipelineState 

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

A compiled compute pipeline configuration.

C++ equivalent: MTL::ComputePipelineState

Implementations

impl ComputePipelineState

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

Create a ComputePipelineState from a raw pointer.

Safety

The pointer must be a valid Metal compute pipeline state object.

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

Get the raw pointer.

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

Get the label.

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

pub fn device(&self) -> Device

Get the device.

C++ equivalent: Device* device() const

pub fn max_total_threads_per_threadgroup(&self) -> UInteger

Get the maximum total threads per threadgroup.

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

pub fn thread_execution_width(&self) -> UInteger

Get the thread execution width.

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

pub fn static_threadgroup_memory_length(&self) -> UInteger

Get the static threadgroup memory length.

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

pub fn support_indirect_command_buffers(&self) -> bool

Check if the pipeline supports indirect command buffers.

C++ equivalent: bool supportIndirectCommandBuffers() const

pub fn imageblock_memory_length(&self, dimensions: Size) -> UInteger

Get the imageblock memory length for given imageblock dimensions.

C++ equivalent: NS::UInteger imageblockMemoryLength(MTL::Size imageblockDimensions)

pub fn gpu_resource_id(&self) -> ResourceID

Get the GPU resource ID for bindless access.

C++ equivalent: ResourceID gpuResourceID() const

pub fn shader_validation(&self) -> ShaderValidation

Get the shader validation mode.

C++ equivalent: ShaderValidation shaderValidation() const

pub fn required_threads_per_threadgroup(&self) -> Size

Get the required threads per threadgroup.

C++ equivalent: Size requiredThreadsPerThreadgroup() const

pub fn function_handle_with_name(&self, name: &str) -> Option<FunctionHandle>

Get a function handle for a function by name.

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

pub fn function_handle_with_function( &self, function: &Function, ) -> Option<FunctionHandle>

Get a function handle for a function.

C++ equivalent: FunctionHandle* functionHandle(const MTL::Function* function)

pub fn function_handle_with_binary_function( &self, binary_function: *const c_void, ) -> Option<FunctionHandle>

Get a function handle for a binary function.

C++ equivalent: FunctionHandle* functionHandle(const MTL4::BinaryFunction* function)

pub fn new_compute_pipeline_state_with_functions( &self, functions: *const c_void, ) -> Result<ComputePipelineState, Error>

Create a new compute pipeline state with additional functions.

C++ equivalent: ComputePipelineState* newComputePipelineState(const NS::Array* functions, NS::Error** error)

pub fn new_compute_pipeline_state_with_binary_functions( &self, binary_functions: *const c_void, ) -> Result<ComputePipelineState, Error>

Create a new compute pipeline state with additional binary functions.

C++ equivalent: ComputePipelineState* newComputePipelineStateWithBinaryFunctions(const NS::Array* additionalBinaryFunctions, NS::Error** error)

pub fn new_intersection_function_table( &self, descriptor: &IntersectionFunctionTableDescriptor, ) -> Option<IntersectionFunctionTable>

Create a new intersection function table.

C++ equivalent: IntersectionFunctionTable* newIntersectionFunctionTable(const MTL::IntersectionFunctionTableDescriptor* descriptor)

pub fn new_visible_function_table( &self, descriptor: &VisibleFunctionTableDescriptor, ) -> Option<VisibleFunctionTable>

Create a new visible function table.

C++ equivalent: VisibleFunctionTable* newVisibleFunctionTable(const MTL::VisibleFunctionTableDescriptor* descriptor)

pub fn reflection(&self) -> Option<ComputePipelineReflection>

Get the pipeline reflection information.

C++ equivalent: ComputePipelineReflection* reflection()

Trait Implementations

impl Clone for ComputePipelineState

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 ComputePipelineState

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

Formats the value using the given formatter.

impl Drop for ComputePipelineState

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for ComputePipelineState

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 ComputePipelineState

impl Sync for ComputePipelineState