Contents

stencilFailureOperation

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

Declaration

var stencilFailureOperation: MTLStencilOperation { get set }

Discussion

The default value is MTLStencilOperation.keep, 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

Related Documentation

  • Metal Shading Language Guide
  • Metal Programming Guide

Configuring stencil functions and operations