vkCmdSetViewportSwizzleNV(3)

C Specification

To dynamically set the viewport swizzle state, call:

// Provided by VK_EXT_extended_dynamic_state3 with VK_NV_viewport_swizzle, VK_EXT_shader_object with VK_NV_viewport_swizzle
void vkCmdSetViewportSwizzleNV(
    VkCommandBuffer                             commandBuffer,
    uint32_t                                    firstViewport,
    uint32_t                                    viewportCount,
    const VkViewportSwizzleNV*                  pViewportSwizzles);

Parameters

commandBuffer is the command buffer into which the command will be recorded.
firstViewport is the index of the first viewport whose parameters are updated by the command.
viewportCount is the number of viewports whose parameters are updated by the command.
pViewportSwizzles is a pointer to an array of VkViewportSwizzleNV structures specifying viewport swizzles.

Description

This command sets the viewport swizzle state for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with VK_DYNAMIC_STATE_VIEWPORT_SWIZZLE_NV set in VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineViewportSwizzleStateCreateInfoNV::viewportCount, and VkPipelineViewportSwizzleStateCreateInfoNV::pViewportSwizzles values used to create the currently active pipeline.

Valid Usage

VUID-vkCmdSetViewportSwizzleNV-None-09423
At least one of the following must be true:
- The extendedDynamicState3ViewportSwizzle feature is enabled
- The shaderObject feature is enabled

Valid Usage (Implicit)

VUID-vkCmdSetViewportSwizzleNV-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdSetViewportSwizzleNV-pViewportSwizzles-parameter
pViewportSwizzles must be a valid pointer to an array of viewportCount valid VkViewportSwizzleNV structures
VUID-vkCmdSetViewportSwizzleNV-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdSetViewportSwizzleNV-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support graphics operations
VUID-vkCmdSetViewportSwizzleNV-videocoding
This command must only be called outside of a video coding scope
VUID-vkCmdSetViewportSwizzleNV-viewportCount-arraylength
viewportCount 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