vkCmdSetLineStippleEXT(3)

# vkCmdSetLineStippleEXT(3) Manual Page

## Name

vkCmdSetLineStippleEXT - Set the dynamic line width state

Loading... please wait.

## C Specification

The line stipple factor and pattern are specified by the VkPipelineRasterizationLineStateCreateInfoEXT::`lineStippleFactor` and VkPipelineRasterizationLineStateCreateInfoEXT::`lineStipplePattern` members of the currently active pipeline, if the pipeline was not created with `VK_DYNAMIC_STATE_LINE_STIPPLE_EXT` enabled.

Otherwise, the line stipple factor and pattern are set by calling `vkCmdSetLineStippleEXT`:

    void vkCmdSetLineStippleEXT(
        VkCommandBuffer                             commandBuffer,
        uint32_t                                    lineStippleFactor,
        uint16_t                                    lineStipplePattern);

## Parameters

- `commandBuffer` is the command buffer into which the command will be recorded.

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

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

## Description

Valid Usage

- `lineStippleFactor` must be in the range [1,256]

Valid Usage (Implicit)

- `commandBuffer` must be a valid VkCommandBuffer handle

- `commandBuffer` must be in the recording state

- The `VkCommandPool` that `commandBuffer` was allocated from must support graphics operations

Host Synchronization

- Host access to `commandBuffer` must be externally synchronized

- Host access to the `VkCommandPool` that `commandBuffer` was allocated from must be externally synchronized

Command Properties

Command Buffer Levels | Render Pass Scope | Supported Queue Types | Pipeline Type
--- | --- | --- | ---
Primary Secondary | Both | Graphics |

## See Also

VkCommandBuffer

## 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 (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.