58 lines
1.8 KiB
Plaintext
58 lines
1.8 KiB
Plaintext
|
vkCmdSetStencilReference(3)
|
||
|
|
===========================
|
||
|
|
|
||
|
|
Name
|
||
|
|
----
|
||
|
|
vkCmdSetStencilReference - Set the stencil reference dynamic state.
|
||
|
|
|
||
|
|
C Specification
|
||
|
|
---------------
|
||
|
|
|
||
|
|
include::../protos/vkCmdSetStencilReference.txt[]
|
||
|
|
|
||
|
|
Parameters
|
||
|
|
----------
|
||
|
|
|
||
|
|
pname:commandBuffer::
|
||
|
|
The command buffer into which to insert the command.
|
||
|
|
|
||
|
|
pname:faceMask::
|
||
|
|
The face or faces to which the command is to apply.
|
||
|
|
|
||
|
|
pname:reference::
|
||
|
|
The new value for the stencil reference dynamic state.
|
||
|
|
|
||
|
|
Description
|
||
|
|
-----------
|
||
|
|
|
||
|
|
fname:vkCmdSetStencilReference sets the reference value used for stencil comparisons
|
||
|
|
on the command buffer specified by pname:commandBuffer. pname:faceMask specifies the
|
||
|
|
face or faces to which the new values are applied. It a bitmask comprised of members
|
||
|
|
of the elink:VkStencilFaceFlagBits enumeration, the definition of which is:
|
||
|
|
|
||
|
|
include::../enums/VkStencilFaceFlagBits.txt[]
|
||
|
|
|
||
|
|
The graphics pipeline bound to pname:commandBuffer must have the
|
||
|
|
ename:VK_DYNAMIC_STATE_STENCIL_REFERENCE dynamic state enabled. When a pipeline
|
||
|
|
that does not have ename:VK_DYNAMIC_STATE_STENCIL_REFERENCE dynamic state enabled is
|
||
|
|
first bound, the value if the stencil reference value is taken from the pipeline and
|
||
|
|
attempts to change it using fname:vkCmdSetStencilReference results in undefined
|
||
|
|
behavior. When a pipeline does have ename:VK_DYNAMIC_STATE_STENCIL_REFERENCE dynamic
|
||
|
|
state enabled is bound, the current value of the stencil reference value becomes undefined
|
||
|
|
and must be set using a call to fname:vkCmdSetStencilReference.
|
||
|
|
|
||
|
|
If the stencil test is disabled in the current graphics pipeline, then the value of
|
||
|
|
the stencil compare mask is ignored.
|
||
|
|
|
||
|
|
include::../validity/protos/vkCmdSetStencilReference.txt[]
|
||
|
|
|
||
|
|
See Also
|
||
|
|
--------
|
||
|
|
|
||
|
|
flink:vkCreateGraphicsPipelines,
|
||
|
|
flink:vkCmdSetStencilCompareMask,
|
||
|
|
flink:vkCmdSetStencilWriteMask,
|
||
|
|
slink:VkPipelineDynamicStateCreateInfo
|
||
|
|
|
||
|
|
include::footer.txt[]
|