public Class EXTDiscardRectangles

VkDiscardRectangleModeEXT - Specify the discard rectangle mode

Description

• DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT specifies that the discard rectangle test is inclusive.
• DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT specifies that the discard rectangle test is exclusive.

See Also

VkPipelineDiscardRectangleStateCreateInfoEXT, CmdSetDiscardRectangleModeEXT

VkDiscardRectangleModeEXT - Specify the discard rectangle mode

Description

• DISCARD_RECTANGLE_MODE_INCLUSIVE_EXT specifies that the discard rectangle test is inclusive.
• DISCARD_RECTANGLE_MODE_EXCLUSIVE_EXT specifies that the discard rectangle test is exclusive.

See Also

VkPipelineDiscardRectangleStateCreateInfoEXT, CmdSetDiscardRectangleModeEXT

Extends VkDynamicState.

Enum values:

• DYNAMIC_STATE_DISCARD_RECTANGLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT

Extends VkDynamicState.

Enum values:

• DYNAMIC_STATE_DISCARD_RECTANGLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT

Extends VkDynamicState.

Enum values:

• DYNAMIC_STATE_DISCARD_RECTANGLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_ENABLE_EXT
• DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT

The extension name.

The extension specification version.

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DISCARD_RECTANGLE_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DISCARD_RECTANGLE_PROPERTIES_EXT
• STRUCTURE_TYPE_PIPELINE_DISCARD_RECTANGLE_STATE_CREATE_INFO_EXT

Unsafe version of: CmdSetDiscardRectangleEXT

Parameters

discardRectangleCount:int

the number of discard rectangles whose state are updated by the command.

Enable discard rectangles dynamically for a command buffer.

C Specification

To dynamically set whether discard rectangles are enabled, call:

void vkCmdSetDiscardRectangleEnableEXT(
    VkCommandBuffer                             commandBuffer,
    VkBool32                                    discardRectangleEnable);

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

• The VK_EXT_discard_rectangles extension must be enabled, and the implementation must support at least specVersion 2 of this extension

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations
• 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

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

discardRectangleEnable:boolean

specifies whether discard rectangles are enabled or not.

Set discard rectangles dynamically for a command buffer.

C Specification

To dynamically set the discard rectangles, call:

void vkCmdSetDiscardRectangleEXT(
    VkCommandBuffer                             commandBuffer,
    uint32_t                                    firstDiscardRectangle,
    uint32_t                                    discardRectangleCount,
    const VkRect2D*                             pDiscardRectangles);

Description

The discard rectangle taken from element i of pDiscardRectangles replace the current state for the discard rectangle at index firstDiscardRectangle + i, for i in [0, discardRectangleCount).

This command sets the discard rectangles for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_DISCARD_RECTANGLE_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineDiscardRectangleStateCreateInfoEXT::pDiscardRectangles values used to create the currently active pipeline.

Valid Usage

• The sum of firstDiscardRectangle and discardRectangleCount must be less than or equal to VkPhysicalDeviceDiscardRectanglePropertiesEXT::maxDiscardRectangles
• The x and y member of offset in each VkRect2D element of pDiscardRectangles must be greater than or equal to 0
• Evaluation of (offset.x + extent.width) in each VkRect2D element of pDiscardRectangles must not cause a signed integer addition overflow
• Evaluation of (offset.y + extent.height) in each VkRect2D element of pDiscardRectangles must not cause a signed integer addition overflow
• If this command is recorded in a secondary command buffer with VkCommandBufferInheritanceViewportScissorInfoNV::viewportScissor2D enabled, then this function must not be called

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pDiscardRectangles must be a valid pointer to an array of discardRectangleCount VkRect2D structures
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations
• This command must only be called outside of a video coding scope
• discardRectangleCount must be greater than 0

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

See Also

VkRect2D

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

firstDiscardRectangle:int

the index of the first discard rectangle whose state is updated by the command.

pDiscardRectangles:VkRect2D.Buffer

a pointer to an array of VkRect2D structures specifying discard rectangles.

Sets the discard rectangle mode dynamically for a command buffer.

C Specification

To dynamically set the discard rectangle mode, call:

void vkCmdSetDiscardRectangleModeEXT(
    VkCommandBuffer                             commandBuffer,
    VkDiscardRectangleModeEXT                   discardRectangleMode);

Description

This command sets the discard rectangle mode for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_DISCARD_RECTANGLE_MODE_EXT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineDiscardRectangleStateCreateInfoEXT::discardRectangleMode value used to create the currently active pipeline.

Valid Usage

• The VK_EXT_discard_rectangles extension must be enabled, and the implementation must support at least specVersion 2 of this extension

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• discardRectangleMode must be a valid VkDiscardRectangleModeEXT value
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics operations
• 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

Parameters

commandBuffer:VkCommandBuffer

the command buffer into which the command will be recorded.

discardRectangleMode:int

specifies the discard rectangle mode for all discard rectangles, either inclusive or exclusive.