Enumeration

MTLStencilOperation

The operation performed on a currently stored stencil value when a comparison test passes or fails.

Declaration

typedef enum MTLStencilOperation : NSUInteger {
    ...
} MTLStencilOperation;

Topics

Constants

MTLStencilOperationKeep

Keep the current stencil value.

MTLStencilOperationZero

Set the stencil value to zero.

MTLStencilOperationReplace

Replace the stencil value with the stencil reference value, which is set by the setStencilReferenceValue: method of MTLRenderCommandEncoder.

MTLStencilOperationIncrementClamp

If the current stencil value is not the maximum representable value, increase the stencil value by one. Otherwise, if the current stencil value is the maximum representable value, do not change the stencil value.

MTLStencilOperationDecrementClamp

If the current stencil value is not zero, decrease the stencil value by one. Otherwise, if the current stencil value is zero, do not change the stencil value.

MTLStencilOperationInvert

Perform a logical bitwise invert operation on the current stencil value.

MTLStencilOperationIncrementWrap

If the current stencil value is not the maximum representable value, increase the stencil value by one. Otherwise, if the current stencil value is the maximum representable value, set the stencil value to zero.

MTLStencilOperationDecrementWrap

If the current stencil value is not zero, decrease the stencil value by one. Otherwise, if the current stencil value is zero, set the stencil value to the maximum representable value.