Struct RenderPipelineState 

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

A compiled render pipeline configuration.

C++ equivalent: MTL::RenderPipelineState

Implementations

impl RenderPipelineState

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

Create a RenderPipelineState from a raw pointer.

Safety

The pointer must be a valid Metal render 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 threadgroup_size_matches_tile_size(&self) -> bool

Check if threadgroup size is multiple of thread execution width.

C++ equivalent: bool threadgroupSizeMatchesTileSize() const

pub fn imageblock_sample_length(&self) -> UInteger

Get the imageblock sample length.

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

pub fn support_indirect_command_buffers(&self) -> bool

Check if alpha-to-coverage is supported.

C++ equivalent: bool supportIndirectCommandBuffers() const

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 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 max_total_threadgroups_per_mesh_grid(&self) -> UInteger

Get the maximum total threadgroups per mesh grid.

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

pub fn max_total_threads_per_mesh_threadgroup(&self) -> UInteger

Get the maximum total threads per mesh threadgroup.

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

pub fn max_total_threads_per_object_threadgroup(&self) -> UInteger

Get the maximum total threads per object threadgroup.

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

pub fn mesh_thread_execution_width(&self) -> UInteger

Get the mesh thread execution width.

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

pub fn object_thread_execution_width(&self) -> UInteger

Get the object thread execution width.

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

pub fn required_threads_per_mesh_threadgroup(&self) -> Size

Get the required threads per mesh threadgroup.

C++ equivalent: Size requiredThreadsPerMeshThreadgroup() const

pub fn required_threads_per_object_threadgroup(&self) -> Size

Get the required threads per object threadgroup.

C++ equivalent: Size requiredThreadsPerObjectThreadgroup() const

pub fn required_threads_per_tile_threadgroup(&self) -> Size

Get the required threads per tile threadgroup.

C++ equivalent: Size requiredThreadsPerTileThreadgroup() const

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

Get a function handle by name and stage.

C++ equivalent: FunctionHandle* functionHandle(const NS::String* name, MTL::RenderStages stage)

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

Get a function handle from a function and stage.

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

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

Create a new intersection function table.

C++ equivalent: IntersectionFunctionTable* newIntersectionFunctionTable(const IntersectionFunctionTableDescriptor*, RenderStages)

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

Create a new visible function table.

C++ equivalent: VisibleFunctionTable* newVisibleFunctionTable(const VisibleFunctionTableDescriptor*, RenderStages)

pub fn new_render_pipeline_state( &self, additional_functions: &RenderPipelineFunctionsDescriptor, ) -> Result<RenderPipelineState, Error>

Create a new render pipeline state with additional binary functions.

C++ equivalent: RenderPipelineState* newRenderPipelineState(const RenderPipelineFunctionsDescriptor*, NS::Error**)

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

Get the pipeline reflection information.

C++ equivalent: RenderPipelineReflection* reflection() const

Trait Implementations

impl Clone for RenderPipelineState

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 RenderPipelineState

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

Formats the value using the given formatter.

impl Drop for RenderPipelineState

fn drop(&mut self)

Executes the destructor for this type.

impl Referencing for RenderPipelineState

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 RenderPipelineState

impl Sync for RenderPipelineState