C Specification

If the bound graphics pipeline state was created with the VK_DYNAMIC_STATE_SCISSOR_WITH_COUNT_EXT dynamic state enabled then the scissor count and scissor rectangular bounds are set dynamically by calling:

// Provided by VK_EXT_extended_dynamic_state
void vkCmdSetScissorWithCountEXT(
    VkCommandBuffer                             commandBuffer,
    uint32_t                                    scissorCount,
    const VkRect2D*                             pScissors);

Parameters

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

  • scissorCount specifies the scissor count.

  • pScissors specifies the scissors to use for drawing.

Description

Valid Usage
  • VUID-vkCmdSetScissorWithCountEXT-None-03396
    The extendedDynamicState feature must be enabled

  • VUID-vkCmdSetScissorWithCountEXT-scissorCount-03397
    scissorCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive

  • VUID-vkCmdSetScissorWithCountEXT-scissorCount-03398
    If the multiple viewports feature is not enabled, scissorCount must be 1

  • VUID-vkCmdSetScissorWithCountEXT-x-03399
    The x and y members of offset member of any element of pScissors must be greater than or equal to 0

  • VUID-vkCmdSetScissorWithCountEXT-offset-03400
    Evaluation of (offset.x + extent.width) must not cause a signed integer addition overflow for any element of pScissors

  • VUID-vkCmdSetScissorWithCountEXT-offset-03401
    Evaluation of (offset.y + extent.height) must not cause a signed integer addition overflow for any element of pScissors

Valid Usage (Implicit)
  • VUID-vkCmdSetScissorWithCountEXT-commandBuffer-parameter
    commandBuffer must be a valid VkCommandBuffer handle

  • VUID-vkCmdSetScissorWithCountEXT-pScissors-parameter
    pScissors must be a valid pointer to an array of scissorCount VkRect2D structures

  • VUID-vkCmdSetScissorWithCountEXT-commandBuffer-recording
    commandBuffer must be in the recording state

  • VUID-vkCmdSetScissorWithCountEXT-commandBuffer-cmdpool
    The VkCommandPool that commandBuffer was allocated from must support graphics operations

  • VUID-vkCmdSetScissorWithCountEXT-scissorCount-arraylength
    scissorCount 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
Command Buffer Levels Render Pass Scope Supported Queue Types Pipeline Type

Primary
Secondary

Both

Graphics

See Also

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 (c) 2014-2020 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0