VKCMDSETSTENCILCOMPA(3)

NAME
vkCmdSetStencilCompareMask - Set the stencil compare mask dynamic state.

C SPECIFICATION

If the pipeline state object is created with the VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK dynamic state enabled, then to dynamically set the stencil compare mask call:

    void vkCmdSetStencilCompareMask(
        VkCommandBuffer                             commandBuffer,
        VkStencilFaceFlags                          faceMask,
        uint32_t                                    compareMask);

PARAMETERS

    • commandBuffer is the command buffer into which the command will be recorded.

    • faceMask is a bitmask specifying the set of stencil state for which to update the compare mask. Bits which can be set include:

        typedef enum VkStencilFaceFlagBits {
            VK_STENCIL_FACE_FRONT_BIT = 0x00000001,
            VK_STENCIL_FACE_BACK_BIT = 0x00000002,
            VK_STENCIL_FRONT_AND_BACK = 0x00000003,
        } VkStencilFaceFlagBits;

        • VK_STENCIL_FACE_FRONT_BIT indicates that only the front set of stencil state is updated.

        • VK_STENCIL_FACE_BACK_BIT indicates that only the back set of stencil state is updated.

        • VK_STENCIL_FRONT_AND_BACK is the combination of VK_STENCIL_FACE_FRONT_BIT and VK_STENCIL_FACE_BACK_BIT and indicates that both sets of stencil state are updated.

    • compareMask is the new value to use as the stencil compare mask.

DESCRIPTION

VALID USAGE

    • commandBuffer must be a valid VkCommandBuffer handle

    • faceMask must be a valid combination of VkStencilFaceFlagBits values

    • faceMask must not be 0

    • commandBuffer must be in the recording state

    • The VkCommandPool that commandBuffer was allocated from must support graphics operations

    • The currently bound graphics pipeline must have been created with the VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK dynamic state enabled

HOST SYNCHRONIZATION

    • Host access to commandBuffer must be externally synchronized

COMMAND PROPERTIES
Command Buffer Levels | Render Pass Scope | Supported Queue Types
Primary Secondary | Both | GRAPHICS

SEE ALSO

VkCommandBuffer, VkStencilFaceFlags

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.