org.lwjgl.vulkan

Class EXTLineRasterization

java.lang.Object

org.lwjgl.vulkan.EXTLineRasterization

public class EXTLineRasterization
extends java.lang.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_EXT_line_rasterization

Extension Type

Device extension

Registered Extension Number

260

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2

Contact

• Jeff Bolz jeffbolznv

Last Modified Date

2019-05-09

IP Status

No known IP claims.

Contributors

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	VK_DYNAMIC_STATE_LINE_STIPPLE_EXT Extends VkDynamicState.
static java.lang.String	VK_EXT_LINE_RASTERIZATION_EXTENSION_NAME The extension name.
static int	VK_EXT_LINE_RASTERIZATION_SPEC_VERSION The extension specification version.
static int	VK_LINE_RASTERIZATION_MODE_BRESENHAM_EXT VkLineRasterizationModeEXT - Line rasterization modes
static int	VK_LINE_RASTERIZATION_MODE_DEFAULT_EXT VkLineRasterizationModeEXT - Line rasterization modes
static int	VK_LINE_RASTERIZATION_MODE_RECTANGULAR_EXT VkLineRasterizationModeEXT - Line rasterization modes
static int	VK_LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT VkLineRasterizationModeEXT - Line rasterization modes
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT Extends VkStructureType.
static int	VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT Extends VkStructureType.

Method Summary

Modifier and Type	Method and Description
static void	vkCmdSetLineStippleEXT(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int lineStippleFactor, short lineStipplePattern) Set the dynamic line width state.

Methods inherited from class java.lang.Object

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

Field Detail

VK_EXT_LINE_RASTERIZATION_SPEC_VERSION

public static final int VK_EXT_LINE_RASTERIZATION_SPEC_VERSION

The extension specification version.

See Also:

Constant Field Values

VK_EXT_LINE_RASTERIZATION_EXTENSION_NAME

public static final java.lang.String VK_EXT_LINE_RASTERIZATION_EXTENSION_NAME

The extension name.

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT

public static final int VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT

See Also:

Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT
• STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT
• STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT

See Also:

Constant Field Values

VK_DYNAMIC_STATE_LINE_STIPPLE_EXT

public static final int VK_DYNAMIC_STATE_LINE_STIPPLE_EXT

Extends VkDynamicState.

See Also:

Constant Field Values

VK_LINE_RASTERIZATION_MODE_DEFAULT_EXT

public static final int VK_LINE_RASTERIZATION_MODE_DEFAULT_EXT

VkLineRasterizationModeEXT - Line rasterization modes

Description

• LINE_RASTERIZATION_MODE_DEFAULT_EXT is equivalent to LINE_RASTERIZATION_MODE_RECTANGULAR_EXT if VkPhysicalDeviceLimits::strictLines is TRUE, otherwise lines are drawn as non-strictLines parallelograms. Both of these modes are defined in Basic Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_EXT specifies lines drawn as if they were rectangles extruded from the line
• LINE_RASTERIZATION_MODE_BRESENHAM_EXT specifies lines drawn by determining which pixel diamonds the line intersects and exits, as defined in Bresenham Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT specifies lines drawn if they were rectangles extruded from the line, with alpha falloff, as defined in Smooth Lines.

See Also

VkPipelineRasterizationLineStateCreateInfoEXT

See Also:

Constant Field Values

VK_LINE_RASTERIZATION_MODE_RECTANGULAR_EXT

public static final int VK_LINE_RASTERIZATION_MODE_RECTANGULAR_EXT

VkLineRasterizationModeEXT - Line rasterization modes

Description

• LINE_RASTERIZATION_MODE_DEFAULT_EXT is equivalent to LINE_RASTERIZATION_MODE_RECTANGULAR_EXT if VkPhysicalDeviceLimits::strictLines is TRUE, otherwise lines are drawn as non-strictLines parallelograms. Both of these modes are defined in Basic Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_EXT specifies lines drawn as if they were rectangles extruded from the line
• LINE_RASTERIZATION_MODE_BRESENHAM_EXT specifies lines drawn by determining which pixel diamonds the line intersects and exits, as defined in Bresenham Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT specifies lines drawn if they were rectangles extruded from the line, with alpha falloff, as defined in Smooth Lines.

See Also

VkPipelineRasterizationLineStateCreateInfoEXT

See Also:

Constant Field Values

VK_LINE_RASTERIZATION_MODE_BRESENHAM_EXT

public static final int VK_LINE_RASTERIZATION_MODE_BRESENHAM_EXT

VkLineRasterizationModeEXT - Line rasterization modes

Description

• LINE_RASTERIZATION_MODE_DEFAULT_EXT is equivalent to LINE_RASTERIZATION_MODE_RECTANGULAR_EXT if VkPhysicalDeviceLimits::strictLines is TRUE, otherwise lines are drawn as non-strictLines parallelograms. Both of these modes are defined in Basic Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_EXT specifies lines drawn as if they were rectangles extruded from the line
• LINE_RASTERIZATION_MODE_BRESENHAM_EXT specifies lines drawn by determining which pixel diamonds the line intersects and exits, as defined in Bresenham Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT specifies lines drawn if they were rectangles extruded from the line, with alpha falloff, as defined in Smooth Lines.

See Also

VkPipelineRasterizationLineStateCreateInfoEXT

See Also:

Constant Field Values

VK_LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT

public static final int VK_LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT

VkLineRasterizationModeEXT - Line rasterization modes

Description

• LINE_RASTERIZATION_MODE_DEFAULT_EXT is equivalent to LINE_RASTERIZATION_MODE_RECTANGULAR_EXT if VkPhysicalDeviceLimits::strictLines is TRUE, otherwise lines are drawn as non-strictLines parallelograms. Both of these modes are defined in Basic Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_EXT specifies lines drawn as if they were rectangles extruded from the line
• LINE_RASTERIZATION_MODE_BRESENHAM_EXT specifies lines drawn by determining which pixel diamonds the line intersects and exits, as defined in Bresenham Line Segment Rasterization.
• LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT specifies lines drawn if they were rectangles extruded from the line, with alpha falloff, as defined in Smooth Lines.

See Also

VkPipelineRasterizationLineStateCreateInfoEXT

See Also:

Constant Field Values

Method Detail

vkCmdSetLineStippleEXT

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

Set the dynamic line width state.

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

Valid Usage

• The bound graphics pipeline must have been created with the DYNAMIC_STATE_LINE_STIPPLE_EXT dynamic state enabled
• 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

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.