VkPipelineRasterizationLineStateCreateInfoKHR(3)

# VkPipelineRasterizationLineStateCreateInfoKHR(3) Manual Page

## Name

VkPipelineRasterizationLineStateCreateInfoKHR - Structure specifying parameters of a newly created pipeline line rasterization state

Loading… please wait.

## C Specification

Line segment rasterization options are controlled by the VkPipelineRasterizationLineStateCreateInfoKHR structure.

The `VkPipelineRasterizationLineStateCreateInfoKHR` structure is defined as:

    // Provided by VK_KHR_line_rasterization
    typedef struct VkPipelineRasterizationLineStateCreateInfoKHR {
        VkStructureType               sType;
        const void*                   pNext;
        VkLineRasterizationModeKHR    lineRasterizationMode;
        VkBool32                      stippledLineEnable;
        uint32_t                      lineStippleFactor;
        uint16_t                      lineStipplePattern;
    } VkPipelineRasterizationLineStateCreateInfoKHR;

or the equivalent

    // Provided by VK_EXT_line_rasterization
    typedef VkPipelineRasterizationLineStateCreateInfoKHR VkPipelineRasterizationLineStateCreateInfoEXT;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `lineRasterizationMode` is a VkLineRasterizationModeKHR value selecting the style of line rasterization.

- `stippledLineEnable` enables stippled line rasterization.

- `lineStippleFactor` is the repeat factor used in stippled line rasterization.

- `lineStipplePattern` is the bit pattern used in stippled line rasterization.

## Description

If `stippledLineEnable` is `VK_FALSE`, the values of `lineStippleFactor` and `lineStipplePattern` are ignored.

Valid Usage

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-lineRasterizationMode-02768
  If `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_RECTANGULAR_KHR`, then the `rectangularLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-lineRasterizationMode-02769
  If `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_BRESENHAM_KHR`, then the `bresenhamLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-lineRasterizationMode-02770
  If `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_KHR`, then the `smoothLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-stippledLineEnable-02771
  If `stippledLineEnable` is `VK_TRUE` and `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_RECTANGULAR_KHR`, then the `stippledRectangularLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-stippledLineEnable-02772
  If `stippledLineEnable` is `VK_TRUE` and `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_BRESENHAM_KHR`, then the `stippledBresenhamLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-stippledLineEnable-02773
  If `stippledLineEnable` is `VK_TRUE` and `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_KHR`, then the `stippledSmoothLines` feature must be enabled

- VUID-VkPipelineRasterizationLineStateCreateInfoEXT-stippledLineEnable-02774
  If `stippledLineEnable` is `VK_TRUE` and `lineRasterizationMode` is `VK_LINE_RASTERIZATION_MODE_DEFAULT_KHR`, then the `stippledRectangularLines` feature must be enabled and VkPhysicalDeviceLimits::`strictLines` must be `VK_TRUE`

Valid Usage (Implicit)

- VUID-VkPipelineRasterizationLineStateCreateInfoKHR-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR`

- VUID-VkPipelineRasterizationLineStateCreateInfoKHR-lineRasterizationMode-parameter
  `lineRasterizationMode` must be a valid VkLineRasterizationModeKHR value

## See Also

VK_EXT_line_rasterization, VK_KHR_line_rasterization, VkBool32, VkLineRasterizationModeKHR, VkStructureType

## Document Notes

For more information, see the Vulkan Specification

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

## Copyright

Copyright 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0