// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/

VkCompareOp(3)
==============

Name
----
VkCompareOp - stencil comparison function

C Specification
---------------

// refBegin VkCompareOp stencil comparison function

pname:compareOp is a symbolic constant that determines the stencil
comparison function:

include::../enums/VkCompareOp.txt[]


Description
-----------

  * ename:VK_COMPARE_OP_NEVER: the test never passes.
  * ename:VK_COMPARE_OP_LESS: the test passes when latexmath:[$R \lt S$].
  * ename:VK_COMPARE_OP_EQUAL: the test passes when latexmath:[$R = S$].
  * ename:VK_COMPARE_OP_LESS_OR_EQUAL: the test passes when latexmath:[$R
    \leq S$].
  * ename:VK_COMPARE_OP_GREATER: the test passes when latexmath:[$R \gt S$].
  * ename:VK_COMPARE_OP_NOT_EQUAL: the test passes when latexmath:[$R \neq
    S$].
  * ename:VK_COMPARE_OP_GREATER_OR_EQUAL: the test passes when latexmath:[$R
    \geq S$].
  * ename:VK_COMPARE_OP_ALWAYS: the test always passes.

// refEnd VkCompareOp


See Also
--------

slink:VkPipelineDepthStencilStateCreateInfo, slink:VkSamplerCreateInfo, slink:VkStencilOpState


Document Notes
--------------

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#VkCompareOp

This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.

include::footer.txt[]