Instance Method

newRenderPipelineStateWithDescriptor:options:reflection:error:

Synchronously creates a render pipeline state object and associated reflection information.

Required.

Declaration

- (id<MTLRenderPipelineState>)newRenderPipelineStateWithDescriptor:(MTLRenderPipelineDescriptor *)descriptor options:(MTLPipelineOption)options reflection:(MTLAutoreleasedRenderPipelineReflection *)reflection error:(NSError * _Nullable *)error;

Parameters

descriptor

A descriptor object that contains graphics rendering state properties, including rasterization, visibility, programmable shader, and blend state.

options

The type of reflection information to return.

reflection

On return, the location this parameter points to is filled with a new object that contains the reflection data about the vertex and fragment functions, including details about function arguments. If the pipeline state could not be compiled, then nil is returned.

error

On input, a pointer to an error object variable. On output, an error object that describes any error that occurred, or nil if the operation succeeded.

Return Value

A new object with the compiled graphics rendering pipeline state.

Discussion

To use the graphics rendering pipeline state for a rendering pass, call the setRenderPipelineState: method of a MTLRenderCommandEncoder object with the MTLRenderPipelineState object.

Topics

Pipeline Options

MTLPipelineOption

The compilation options that determine which argument information to provide.

See Also

Creating a Render Pipeline

- newRenderPipelineStateWithDescriptor:completionHandler:

Asynchronously creates a render pipeline state object.

Required.

- newRenderPipelineStateWithDescriptor:options:completionHandler:

Asynchronously creates a render pipeline state object and associated reflection information.

Required.

- newRenderPipelineStateWithDescriptor:error:

Synchronously creates a render pipeline state object.

Required.

- newRenderPipelineStateWithTileDescriptor:options:completionHandler:

Asynchronously creates a render pipeline state object, and associated reflection information, for a tile shader.

Required.

- newRenderPipelineStateWithTileDescriptor:options:reflection:error:

Synchronously creates a render pipeline state object, and associated reflection information, for a tile shader.

Required.