vkCmdSetDiscardRectangleEnableEXT(3)

# vkCmdSetDiscardRectangleEnableEXT(3) Manual Page

## Name

vkCmdSetDiscardRectangleEnableEXT - Enable discard rectangles dynamically for a command buffer

Loading… please wait.

## C Specification

To dynamically set whether discard rectangles are enabled, call:

    // Provided by VK_EXT_discard_rectangles
    void vkCmdSetDiscardRectangleEnableEXT(
        VkCommandBuffer                             commandBuffer,
        VkBool32                                    discardRectangleEnable);

## Parameters

- `commandBuffer` is the command buffer into which the command will be recorded.

- `discardRectangleEnable` specifies whether discard rectangles are enabled or not.

## Description

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 VK_QUEUE_GRAPHICS_BIT operations

- VUID-vkCmdSetDiscardRectangleEnableEXT-videocoding
  This command must only be called outside of a video coding scope

Host Synchronization

- Host access to `commandBuffer` must be externally synchronized

- Host access to the `VkCommandPool` that `commandBuffer` was allocated from must be externally synchronized

Command Properties

Command Buffer Levels | Render Pass Scope | Video Coding Scope | Supported Queue Types | Command Type
--- | --- | --- | --- | ---
Primary Secondary | Both | Outside | VK_QUEUE_GRAPHICS_BIT | State

Conditional Rendering

vkCmdSetDiscardRectangleEnableEXT is not affected by conditional rendering

## See Also

VK_EXT_discard_rectangles, VkBool32, VkCommandBuffer

## Document Notes

For more information, see the Vulkan Specification.

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

## Copyright

Copyright 2014-2026 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0