Package org.lwjgl.vulkan

Class KHRLineRasterization

java.lang.Object

org.lwjgl.vulkan.KHRLineRasterization

public class KHRLineRasterization
extends Object

This extension adds some line rasterization features that are commonly used in CAD applications and supported in other APIs like OpenGL. Bresenham-style line rasterization is supported, smooth rectangular lines (coverage to alpha) are supported, and stippled lines are supported for all three line rasterization modes.

Name String

VK_KHR_line_rasterization

Extension Type

Device extension

Registered Extension Number

535

Revision

1

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Piers Daniell pdaniell-nv

Other Extension Metadata

Last Modified Date

2023-06-08

IP Status

No known IP claims.

Contributors

• Jeff Bolz, NVIDIA
• Allen Jensen, NVIDIA
• Faith Ekstrand, Intel

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_DYNAMIC_STATE_LINE_STIPPLE_KHR	Extends VkDynamicState.
static final String	VK_KHR_LINE_RASTERIZATION_EXTENSION_NAME	The extension name.
static final int	VK_KHR_LINE_RASTERIZATION_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	vkCmdSetLineStippleKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int lineStippleFactor, short lineStipplePattern)	Set line stipple dynamically for a command buffer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_KHR_LINE_RASTERIZATION_SPEC_VERSION

public static final int VK_KHR_LINE_RASTERIZATION_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_LINE_RASTERIZATION_EXTENSION_NAME

public static final String VK_KHR_LINE_RASTERIZATION_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_KHR
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_KHR

See Also:

• Constant Field Values

VK_DYNAMIC_STATE_LINE_STIPPLE_KHR

public static final int VK_DYNAMIC_STATE_LINE_STIPPLE_KHR

Extends VkDynamicState.

See Also:

• Constant Field Values

Method Details

vkCmdSetLineStippleKHR

public static void vkCmdSetLineStippleKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 int lineStippleFactor,
 short lineStipplePattern)

Set line stipple dynamically for a command buffer.

C Specification

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);

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 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

• 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
• 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

Parameters:

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

lineStippleFactor - the repeat factor used in stippled line rasterization.

lineStipplePattern - the bit pattern used in stippled line rasterization.