vkCmdSetLineStippleKHR(3)

# vkCmdSetLineStippleKHR(3) Manual Page

## Name

vkCmdSetLineStippleKHR - Set line stipple dynamically for a command buffer

Loading… please wait.

## C Specification

To dynamically set the line stipple state, call:

    // Provided by VK_KHR_line_rasterization
    void vkCmdSetLineStippleKHR(
        VkCommandBuffer                             commandBuffer,
        uint32_t                                    lineStippleFactor,
        uint16_t                                    lineStipplePattern);

or the equivalent command

    // Provided by VK_EXT_line_rasterization
    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

This command sets the line stipple state for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with `VK_DYNAMIC_STATE_LINE_STIPPLE_EXT` set in VkPipelineDynamicStateCreateInfo::`pDynamicStates`. Otherwise, this state is specified by the VkPipelineRasterizationLineStateCreateInfoKHR::`lineStippleFactor` and VkPipelineRasterizationLineStateCreateInfoKHR::`lineStipplePattern` values used to create the currently active pipeline.

Valid Usage

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

Valid Usage (Implicit)

- VUID-vkCmdSetLineStippleKHR-commandBuffer-parameter
  `commandBuffer` must be a valid VkCommandBuffer handle

- VUID-vkCmdSetLineStippleKHR-commandBuffer-recording
  `commandBuffer` must be in the recording state

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

- VUID-vkCmdSetLineStippleKHR-videocoding
  This command must only be called outside of a video coding scope

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 | Video Coding Scope | Supported Queue Types | Command Type
--- | --- | --- | --- | ---
Primary Secondary | Both | Outside | Graphics | State

## See Also

VK_EXT_line_rasterization, VK_KHR_line_rasterization, 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 2014-2024 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0