vkCmdSetLineStipple
To dynamically set the line stipple state, call:
void vkCmdSetLineStippleKHR(
VkCommandBuffer commandBuffer,
uint32_t lineStippleFactor,
uint16_t lineStipplePattern);
or the equivalent command
void vkCmdSetLineStippleEXT(
VkCommandBuffer commandBuffer,
uint32_t lineStippleFactor,
uint16_t lineStipplePattern);
commandBufferis the command buffer into which the command will be recorded.lineStippleFactoris the repeat factor used in stippled line rasterization.lineStipplePatternis the bit pattern used in stippled line rasterization.
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 set in
VkPipelineDynamicStateCreateInfo::pDynamicStates.
Otherwise, this state is specified by the
VkPipelineRasterizationLineStateCreateInfo::lineStippleFactor
and
VkPipelineRasterizationLineStateCreateInfo::lineStipplePattern
values used to create the currently active pipeline.
Valid Usage
VUID-vkCmdSetLineStipple-lineStippleFactor-02776
lineStippleFactor must be in the range [1,256]
Valid Usage (Implicit)
VUID-vkCmdSetLineStipple-commandBuffer-parameter
commandBuffer must be a valid VkCommandBuffer handle
VUID-vkCmdSetLineStipple-commandBuffer-recording
commandBuffer must be in the recording state
VUID-vkCmdSetLineStipple-commandBuffer-cmdpool
The VkCommandPool that commandBuffer was allocated from must support graphics operations
VUID-vkCmdSetLineStipple-videocoding
This command must only be called outside of a video coding scope
Host Synchronization
- Host access to
commandBuffermust be externally synchronized - Host access to the
VkCommandPoolthatcommandBufferwas allocated from must be externally synchronized ::