VKPIPELINEVIEWPORTST(3)

NAME
VkPipelineViewportStateCreateInfo - Structure specifying parameters of a newly created pipeline viewport state

C SPECIFICATION

The VkPipelineViewportStateCreateInfo structure is defined as:

    typedef struct VkPipelineViewportStateCreateInfo {
        VkStructureType                       sType;
        const void*                           pNext;
        VkPipelineViewportStateCreateFlags    flags;
        uint32_t                              viewportCount;
        const VkViewport*                     pViewports;
        uint32_t                              scissorCount;
        const VkRect2D*                       pScissors;
    } VkPipelineViewportStateCreateInfo;

MEMBERS

    • sType is the type of this structure.

    • pNext is NULL or a pointer to an extension-specific structure.

    • flags is reserved for future use.

    • viewportCount is the number of viewports used by the pipeline.

    • pViewports is a pointer to an array of VkViewport structures, defining the viewport transforms. If the viewport state is dynamic, this member is ignored.

    • scissorCount is the number of scissors and must match the number of viewports.

    • pScissors is a pointer to an array of VkRect2D structures which define the rectangular bounds of the scissor for the corresponding viewport. If the scissor state is dynamic, this member is ignored.

DESCRIPTION

VALID USAGE

    • sType must be VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO

    • pNext must be NULL

    • flags must be 0

    • viewportCount must be greater than 0

    • scissorCount must be greater than 0

    • If the multiple viewports feature is not enabled, viewportCount must be 1

    • If the multiple viewports feature is not enabled, scissorCount must be 1

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

    • scissorCount must be between 1 and VkPhysicalDeviceLimits::maxViewports, inclusive

    • scissorCount and viewportCount must be identical

SEE ALSO

VkGraphicsPipelineCreateInfo, VkPipelineViewportStateCreateFlags, VkRect2D, VkStructureType, VkViewport

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.