VKCMDSETVIEWPORT(3)

NAME
vkCmdSetViewport - Set the viewport on a command buffer

C SPECIFICATION

If the bound pipeline state object was not created with the VK_DYNAMIC_STATE_VIEWPORT dynamic state enabled, viewport transformation parameters are specified using the pViewports member of VkPipelineViewportStateCreateInfo in the pipeline state object. If the pipeline state object was created with the VK_DYNAMIC_STATE_VIEWPORT dynamic state enabled, the viewport transformation parameters are dynamically set and changed with the command:

    void vkCmdSetViewport(
        VkCommandBuffer                             commandBuffer,
        uint32_t                                    firstViewport,
        uint32_t                                    viewportCount,
        const VkViewport*                           pViewports);

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.

    • pViewports is a pointer to an array of VkViewport structures specifying viewport parameters.

DESCRIPTION

The viewport parameters taken from element i of pViewports replace the current state for the viewport index firstViewport + i, for i in [0, viewportCount). Valid Usage

    • The currently bound graphics pipeline must have been created with the VK_DYNAMIC_STATE_VIEWPORT dynamic state enabled

    • firstViewport must be less than VkPhysicalDeviceLimits::maxViewports

    • The sum of firstViewport and viewportCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive
Valid Usage (Implicit)

    • commandBuffer must be a valid VkCommandBuffer handle

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

    • commandBuffer must be in the recording state

    • The VkCommandPool that commandBuffer was allocated from must support graphics operations

    • viewportCount must be greater than 0
Host Synchronization

    • Host access to commandBuffer must be externally synchronized
Command Properties
Command Buffer Levels | Render Pass Scope | Supported Queue Types
Primary Secondary | Both | GRAPHICS

SEE ALSO

VkCommandBuffer, VkViewport

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdSetViewport

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

COPYRIGHT

Copyright (c) 2014-2016 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.

AUTHOR

Khronos Group
    Author.