Function Prototype

vkCmdSetViewportWithCount

Set the viewport count and viewports dynamically for a command buffer

To dynamically set the viewport count and viewports, call:

void vkCmdSetViewportWithCountEXT(
    VkCommandBuffer commandBuffer,
    uint32_t viewportCount,
    const VkViewport* pViewports);
  • commandBuffer is the command buffer into which the command will be recorded.
  • viewportCount specifies the viewport count.
  • pViewports specifies the viewports to use for drawing.

This command sets the viewport count and viewports state for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_VIEWPORT_WITH_COUNT set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the corresponding VkPipelineViewportStateCreateInfo::viewportCount and pViewports values used to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetViewportWithCount-None-08971

At least one of the following must be true:- the extendedDynamicState feature is enabled

VUID-vkCmdSetViewportWithCount-viewportCount-03394

viewportCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive

VUID-vkCmdSetViewportWithCount-viewportCount-03395

If the multiViewport feature is not enabled, viewportCount must be 1

::

Valid Usage (Implicit)

VUID-vkCmdSetViewportWithCount-pViewports-parameter

pViewports must be a valid pointer to an array of viewportCount valid VkViewport structures

VUID-vkCmdSetViewportWithCount-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support graphics operations

VUID-vkCmdSetViewportWithCount-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 ::