VKCMDSETLINEWIDTH(3)

NAME
vkCmdSetLineWidth - Set the dynamic line width state.

C SPECIFICATION

    void vkCmdSetLineWidth(
        VkCommandBuffer                             commandBuffer,
        float                                       lineWidth);

PARAMETERS

commandBuffer
    The command buffer into which to insert the command.

lineWidth
    The new line width.

DESCRIPTION

vkCmdSetLineWidth sets the dymamic line width for the command buffer specified in commandBuffer to the value specified in lineWidth. Line primitives drawn subsequent to this command, either directly using line topologies or by generation of line primitives mid-pipeline, will assume the specified width.

Dynamic line width may be modified only if the current pipeline state object was created with the VK_DYNAMIC_STATE_LINE_WIDTH dynamic state enabled. When a pipeline that does not have VK_DYNAMIC_STATE_LINE_WIDTH dynamic state enabled is first bound, the line width is taken from the pipeline and attempts to change it using vkCmdSetLineWidth results in undefined behavior. When a pipeline does have VK_DYNAMIC_STATE_LINE_WIDTH dynamic state enabled is first bound, the current value for line width becomes undefined and must be set using a call to vkCmdSetLineWidth.

VALID USAGE

    • 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

    • If the wide lines feature is not enabled, lineWidth must be 1.0

HOST SYNCHRONIZATION

    • Host access to commandBuffer must be externally synchronized

COMMAND PROPERTIES
Command Buffer Levels | Render Pass Scope | Supported Queue Types
Primary Secondary | Both | GRAPHICS

SEE ALSO

vkCmdSetDepthBias, vkCreateGraphicsPipelines, VkPipelineDynamicStateCreateInfo

COPYRIGHT

Copyright © 2014-2016 Khronos Group. This material may be distributed subject to the terms and conditions set forth in the Open Publication License, v 1.0, 8 June 1999. http://opencontent.org/openpub/.

AUTHOR

Khronos Group
    Author.