vkCmdSetDiscardRectangleEnableEXT
Enable discard rectangles dynamically for a command buffer
To dynamically set whether discard rectangles are enabled, call:
void vkCmdSetDiscardRectangleEnableEXT(
VkCommandBuffer commandBuffer,
VkBool32 discardRectangleEnable);
commandBufferis the command buffer into which the command will be recorded.discardRectangleEnablespecifies whether discard rectangles are enabled or not.
This command sets the discard rectangle enable for subsequent drawing
commands
when drawing using shader objects, or
when the graphics pipeline is created with
VK_DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT set in
VkPipelineDynamicStateCreateInfo::pDynamicStates.
Otherwise, this state is implied by the
VkPipelineDiscardRectangleStateCreateInfoEXT::discardRectangleCount
value used to create the currently active pipeline, where a non-zero
discardRectangleCount implicitly enables discard rectangles, otherwise
they are disabled.
Valid Usage
VUID-vkCmdSetDiscardRectangleEnableEXT-specVersion-07851
The VK_EXT_discard_rectangles extension must be enabled, and
the implementation must support at least specVersion 2 of this
extension
Valid Usage (Implicit)
VUID-vkCmdSetDiscardRectangleEnableEXT-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdSetDiscardRectangleEnableEXT-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdSetDiscardRectangleEnableEXT-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support graphics operations
VUID-vkCmdSetDiscardRectangleEnableEXT-videocoding
This command must only be called outside of a video coding scope
Host Synchronization
- Host access to
commandBuffermust be externally synchronized - Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized ::