# Interface VulkanStencilOpStateType

All Known Implementing Classes:
  `VulkanStencilOpState`

@Immutable public interface VulkanStencilOpStateType

See Also:
  - "VkStencilOpState"

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `compareMask()`
  `VulkanCompareOp`
  `compareOp()`
  `VulkanStencilOp`
  `depthFailOp()`
  `VulkanStencilOp`
  `failOp()`
  `VulkanStencilOp`
  `passOp()`
  `int`
  `reference()`
  `int`
  `writeMask()`

- ## Method Details

  - ### failOp

    @Parameter VulkanStencilOp failOp()
    Returns:
      The action performed on samples that fail the stencil test.

  - ### passOp

    @Parameter VulkanStencilOp passOp()
    Returns:
      The action performed on samples that pass both the depth and stencil tests.

  - ### depthFailOp

    @Parameter VulkanStencilOp depthFailOp()
    Returns:
      The action performed on samples that pass the stencil test and fail the depth test.

  - ### compareOp

    @Parameter VulkanCompareOp compareOp()
    Returns:
      The comparison operator used in the stencil test.

  - ### compareMask

    @Parameter int compareMask()
    Returns:
      The bits of the unsigned integer stencil values participating in the stencil test.

  - ### writeMask

    @Parameter int writeMask()
    Returns:
      The bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

  - ### reference

    @Parameter int reference()
    Returns:
      An integer reference value that is used in the unsigned stencil comparison.