VKPIPELINERASTERIZAT(3)

NAME
VkPipelineRasterizationStateCreateInfo - Structure specifying parameters of a newly created pipeline rasterization state

C SPECIFICATION

The VkPipelineRasterizationStateCreateInfo structure is defined as:

    typedef struct VkPipelineRasterizationStateCreateInfo {
        VkStructureType                            sType;
        const void*                                pNext;
        VkPipelineRasterizationStateCreateFlags    flags;
        VkBool32                                   depthClampEnable;
        VkBool32                                   rasterizerDiscardEnable;
        VkPolygonMode                              polygonMode;
        VkCullModeFlags                            cullMode;
        VkFrontFace                                frontFace;
        VkBool32                                   depthBiasEnable;
        float                                      depthBiasConstantFactor;
        float                                      depthBiasClamp;
        float                                      depthBiasSlopeFactor;
        float                                      lineWidth;
    } VkPipelineRasterizationStateCreateInfo;

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.

    • depthClampEnable controls whether to clamp the fragment’s depth values instead of clipping primitives to the z planes of the frustum, as described in Primitive Clipping.

    • rasterizerDiscardEnable controls whether primitives are discarded immediately before the rasterization stage.

    • polygonMode is the triangle rendering mode. See VkPolygonMode.

    • cullMode is the triangle facing direction used for primitive culling. See VkCullModeFlagBits.

    • frontFace is the front-facing triangle orientation to be used for culling. See VkFrontFace.

    • depthBiasEnable controls whether to bias fragment depth values.

    • depthBiasConstantFactor is a scalar factor controlling the constant depth value added to each fragment.

    • depthBiasClamp is the maximum (or minimum) depth bias of a fragment.

    • depthBiasSlopeFactor is a scalar factor applied to a fragment’s slope in depth bias calculations.

    • lineWidth is the width of rasterized line segments.

DESCRIPTION
Valid Usage

    • If the depth clamping feature is not enabled, depthClampEnable must be VK_FALSE

    • If the non-solid fill modes feature is not enabled, polygonMode must be VK_POLYGON_MODE_FILL
Valid Usage (Implicit)

    • sType must be VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO

    • pNext must be NULL

    • flags must be 0

    • polygonMode must be a valid VkPolygonMode value

    • cullMode must be a valid combination of VkCullModeFlagBits values

    • frontFace must be a valid VkFrontFace value

SEE ALSO

VkBool32, VkCullModeFlags, VkFrontFace, VkGraphicsPipelineCreateInfo, VkPipelineRasterizationStateCreateFlags, VkPolygonMode, VkStructureType

DOCUMENT NOTES

For more information, see the Vulkan Specification at URL

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

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.