Instance Method

newComputePipelineStateWithFunction:options:reflection:error:

Synchronously creates a new compute pipeline state object, and associated reflection information, using a function object.

Required.

Declaration

- (id<MTLComputePipelineState>)newComputePipelineStateWithFunction:(id<MTLFunction>)computeFunction options:(MTLPipelineOption)options reflection:(MTLAutoreleasedComputePipelineReflection *)reflection error:(NSError * _Nullable *)error;

Parameters

function: A function object to be compiled into a compute pipeline state object.
options: The type of reflection information that should be returned.
reflection: Reflection data about the compute function, including details about function arguments.
error: An error object that describes the problem, or nil if the operation succeeded.

Return Value

A new object that can be used as a compute pipeline state.

Discussion

To use the compute pipeline state for a compute pass, call the setComputePipelineState: method of a MTLComputeCommandEncoder object with the MTLComputePipelineState object.

Topics

Pipeline Options

MTLPipelineOption

The compilation options that determine which argument information to provide.