Instance Property

stencilFailureOperation

The operation that is performed to update the values in the stencil attachment when the stencil test fails.

Declaration

@property(nonatomic) MTLStencilOperation stencilFailureOperation;

Discussion

The default value is MTLStencilOperationKeep, which does not change the current stencil value. For more information on possible values, see MTLStencilOperation.

When the stencil test fails for a pixel, its incoming color, depth, or stencil values are discarded.

See Also

Specifying Stencil Functions and Operations

depthFailureOperation

The operation that is performed to update the values in the stencil attachment when the stencil test passes, but the depth test fails.

depthStencilPassOperation

The operation that is performed to update the values in the stencil attachment when both the stencil test and the depth test pass.

stencilCompareFunction

The comparison that is performed between the masked reference value and a masked value in the stencil attachment.