Vulkan.Extensions.VK_EXT_line_rasterization

Name

VK_EXT_line_rasterization - device extension

VK_EXT_line_rasterization

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

Special Use

• CAD support

Contact

• Jeff Bolz @jeffbolznv%0A<<Here describe the issue or question you have about the VK_EXT_line_rasterization extension> >

Other Extension Metadata

Last Modified Date

2019-05-09

IP Status

No known IP claims.

Contributors

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

Description

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.

New Commands

• cmdSetLineStippleEXT

New Structures

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceLineRasterizationFeaturesEXT

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceLineRasterizationPropertiesEXT

• Extending PipelineRasterizationStateCreateInfo:

  • PipelineRasterizationLineStateCreateInfoEXT

New Enums

• LineRasterizationModeEXT

New Enum Constants

• EXT_LINE_RASTERIZATION_EXTENSION_NAME

• EXT_LINE_RASTERIZATION_SPEC_VERSION

• Extending DynamicState:

  • DYNAMIC_STATE_LINE_STIPPLE_EXT

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_FEATURES_EXT
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_LINE_RASTERIZATION_PROPERTIES_EXT
  • STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT

Issues

(1) Do we need to support Bresenham-style and smooth lines with more than
one rasterization sample? i.e. the equivalent of glDisable(GL_MULTISAMPLE)
in OpenGL when the framebuffer has more than one sample?

RESOLVED: Yes.
For simplicity, Bresenham line rasterization carries forward a few
restrictions from OpenGL, such as not supporting per-sample shading, alpha
to coverage, or alpha to one.

Version History

• Revision 1, 2019-05-09 (Jeff Bolz)

  • Initial draft

See Also

LineRasterizationModeEXT, PhysicalDeviceLineRasterizationFeaturesEXT, PhysicalDeviceLineRasterizationPropertiesEXT, PipelineRasterizationLineStateCreateInfoEXT, cmdSetLineStippleEXT

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

cmdSetLineStippleEXT

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("lineStippleFactor" ::: Word32)

lineStippleFactor is the repeat factor used in stippled line rasterization.

-> ("lineStipplePattern" ::: Word16)

lineStipplePattern is the bit pattern used in stippled line rasterization.

-> io ()

vkCmdSetLineStippleEXT - Set line stipple dynamically for a command buffer

Description

This command sets the line stipple state for subsequent drawing commands when the graphics pipeline is created with DYNAMIC_STATE_LINE_STIPPLE_EXT set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the PipelineRasterizationLineStateCreateInfoEXT::lineStippleFactor and PipelineRasterizationLineStateCreateInfoEXT::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 CommandBuffer handle

• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

Command Buffer Levels	Render Pass Scope	Supported Queue Types
Primary Secondary	Both	Graphics

See Also

VK_EXT_line_rasterization, CommandBuffer

data PhysicalDeviceLineRasterizationFeaturesEXT

VkPhysicalDeviceLineRasterizationFeaturesEXT - Structure describing the line rasterization features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceLineRasterizationFeaturesEXT structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceLineRasterizationFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_EXT_line_rasterization, Bool32, StructureType

Constructors

PhysicalDeviceLineRasterizationFeaturesEXT

Fields

• rectangularLines :: Bool

  rectangularLines indicates whether the implementation supports rectangular line rasterization.

• bresenhamLines :: Bool

  bresenhamLines indicates whether the implementation supports Bresenham-style line rasterization.

• smoothLines :: Bool

  smoothLines indicates whether the implementation supports smooth line rasterization.

• stippledRectangularLines :: Bool

  stippledRectangularLines indicates whether the implementation supports stippled line rasterization with LINE_RASTERIZATION_MODE_RECTANGULAR_EXT lines, or with LINE_RASTERIZATION_MODE_DEFAULT_EXT lines if PhysicalDeviceLimits::strictLines is TRUE.

• stippledBresenhamLines :: Bool

  stippledBresenhamLines indicates whether the implementation supports stippled line rasterization with LINE_RASTERIZATION_MODE_BRESENHAM_EXT lines.

• stippledSmoothLines :: Bool

  stippledSmoothLines indicates whether the implementation supports stippled line rasterization with LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT lines.

Instances

Eq PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

(==) :: PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> Bool

(/=) :: PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> Bool

Show PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

showsPrec :: Int -> PhysicalDeviceLineRasterizationFeaturesEXT -> ShowS

show :: PhysicalDeviceLineRasterizationFeaturesEXT -> String

showList :: [PhysicalDeviceLineRasterizationFeaturesEXT] -> ShowS

Storable PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

sizeOf :: PhysicalDeviceLineRasterizationFeaturesEXT -> Int

alignment :: PhysicalDeviceLineRasterizationFeaturesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> Int -> IO PhysicalDeviceLineRasterizationFeaturesEXT

pokeElemOff :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> Int -> PhysicalDeviceLineRasterizationFeaturesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceLineRasterizationFeaturesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceLineRasterizationFeaturesEXT -> IO ()

peek :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO PhysicalDeviceLineRasterizationFeaturesEXT

poke :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> IO ()

FromCStruct PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

peekCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO PhysicalDeviceLineRasterizationFeaturesEXT

ToCStruct PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

withCStruct :: PhysicalDeviceLineRasterizationFeaturesEXT -> (Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceLineRasterizationFeaturesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

zero :: PhysicalDeviceLineRasterizationFeaturesEXT

data PhysicalDeviceLineRasterizationPropertiesEXT

VkPhysicalDeviceLineRasterizationPropertiesEXT - Structure describing line rasterization properties supported by an implementation

Description

If the PhysicalDeviceLineRasterizationPropertiesEXT structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

See Also

VK_EXT_line_rasterization, StructureType

Constructors

PhysicalDeviceLineRasterizationPropertiesEXT

Fields

• lineSubPixelPrecisionBits :: Word32

  lineSubPixelPrecisionBits is the number of bits of subpixel precision in framebuffer coordinates xf and yf when rasterizing line segments.

Instances

Eq PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

(==) :: PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> Bool

(/=) :: PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> Bool

Show PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

showsPrec :: Int -> PhysicalDeviceLineRasterizationPropertiesEXT -> ShowS

show :: PhysicalDeviceLineRasterizationPropertiesEXT -> String

showList :: [PhysicalDeviceLineRasterizationPropertiesEXT] -> ShowS

Storable PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

sizeOf :: PhysicalDeviceLineRasterizationPropertiesEXT -> Int

alignment :: PhysicalDeviceLineRasterizationPropertiesEXT -> Int

peekElemOff :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> Int -> IO PhysicalDeviceLineRasterizationPropertiesEXT

pokeElemOff :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> Int -> PhysicalDeviceLineRasterizationPropertiesEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceLineRasterizationPropertiesEXT

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceLineRasterizationPropertiesEXT -> IO ()

peek :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO PhysicalDeviceLineRasterizationPropertiesEXT

poke :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> IO ()

FromCStruct PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

peekCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO PhysicalDeviceLineRasterizationPropertiesEXT

ToCStruct PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

withCStruct :: PhysicalDeviceLineRasterizationPropertiesEXT -> (Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceLineRasterizationPropertiesEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

zero :: PhysicalDeviceLineRasterizationPropertiesEXT

data PipelineRasterizationLineStateCreateInfoEXT

VkPipelineRasterizationLineStateCreateInfoEXT - Structure specifying parameters of a newly created pipeline line rasterization state

Description

If stippledLineEnable is FALSE, the values of lineStippleFactor and lineStipplePattern are ignored.

Valid Usage

• If lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_EXT, then the rectangularLines feature must be enabled

• If lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM_EXT, then the bresenhamLines feature must be enabled
• If lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT, then the smoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_EXT, then the stippledRectangularLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_BRESENHAM_EXT, then the stippledBresenhamLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT, then the stippledSmoothLines feature must be enabled
• If stippledLineEnable is TRUE and lineRasterizationMode is LINE_RASTERIZATION_MODE_DEFAULT_EXT, then the stippledRectangularLines feature must be enabled and PhysicalDeviceLimits::strictLines must be TRUE

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_RASTERIZATION_LINE_STATE_CREATE_INFO_EXT

• lineRasterizationMode must be a valid LineRasterizationModeEXT value

See Also

VK_EXT_line_rasterization, Bool32, LineRasterizationModeEXT, StructureType

Constructors

PipelineRasterizationLineStateCreateInfoEXT

Fields

• lineRasterizationMode :: LineRasterizationModeEXT

  lineRasterizationMode is a LineRasterizationModeEXT value selecting the style of line rasterization.

• stippledLineEnable :: Bool

  stippledLineEnable enables stippled line rasterization.

• lineStippleFactor :: Word32

  lineStippleFactor is the repeat factor used in stippled line rasterization.

• lineStipplePattern :: Word16

  lineStipplePattern is the bit pattern used in stippled line rasterization.

Instances

Eq PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

(==) :: PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> Bool

(/=) :: PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> Bool

Show PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

showsPrec :: Int -> PipelineRasterizationLineStateCreateInfoEXT -> ShowS

show :: PipelineRasterizationLineStateCreateInfoEXT -> String

showList :: [PipelineRasterizationLineStateCreateInfoEXT] -> ShowS

Storable PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

sizeOf :: PipelineRasterizationLineStateCreateInfoEXT -> Int

alignment :: PipelineRasterizationLineStateCreateInfoEXT -> Int

peekElemOff :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> Int -> IO PipelineRasterizationLineStateCreateInfoEXT

pokeElemOff :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> Int -> PipelineRasterizationLineStateCreateInfoEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO PipelineRasterizationLineStateCreateInfoEXT

pokeByteOff :: Ptr b -> Int -> PipelineRasterizationLineStateCreateInfoEXT -> IO ()

peek :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO PipelineRasterizationLineStateCreateInfoEXT

poke :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> IO ()

FromCStruct PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

peekCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO PipelineRasterizationLineStateCreateInfoEXT

ToCStruct PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

withCStruct :: PipelineRasterizationLineStateCreateInfoEXT -> (Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b) -> IO b

pokeCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> IO b -> IO b

withZeroCStruct :: (Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b) -> IO b

pokeZeroCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineRasterizationLineStateCreateInfoEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

zero :: PipelineRasterizationLineStateCreateInfoEXT

newtype LineRasterizationModeEXT

VkLineRasterizationModeEXT - Line rasterization modes

See Also

VK_EXT_line_rasterization, PipelineRasterizationLineStateCreateInfoEXT

Constructors

LineRasterizationModeEXT Int32

Bundled Patterns

pattern LINE_RASTERIZATION_MODE_DEFAULT_EXT :: LineRasterizationModeEXT

LINE_RASTERIZATION_MODE_DEFAULT_EXT is equivalent to LINE_RASTERIZATION_MODE_RECTANGULAR_EXT if PhysicalDeviceLimits::strictLines is TRUE, otherwise lines are drawn as non-strictLines parallelograms. Both of these modes are defined in Basic Line Segment Rasterization.

pattern LINE_RASTERIZATION_MODE_RECTANGULAR_EXT :: LineRasterizationModeEXT

LINE_RASTERIZATION_MODE_RECTANGULAR_EXT specifies lines drawn as if they were rectangles extruded from the line

pattern LINE_RASTERIZATION_MODE_BRESENHAM_EXT :: LineRasterizationModeEXT

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.

pattern LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT :: LineRasterizationModeEXT

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.

Instances

Eq LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

(==) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

(/=) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

Ord LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

compare :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Ordering

(<) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

(<=) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

(>) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

(>=) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool

max :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> LineRasterizationModeEXT

min :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> LineRasterizationModeEXT

Read LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

readsPrec :: Int -> ReadS LineRasterizationModeEXT

readList :: ReadS [LineRasterizationModeEXT]

readPrec :: ReadPrec LineRasterizationModeEXT

readListPrec :: ReadPrec [LineRasterizationModeEXT]

Show LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

showsPrec :: Int -> LineRasterizationModeEXT -> ShowS

show :: LineRasterizationModeEXT -> String

showList :: [LineRasterizationModeEXT] -> ShowS

Storable LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

sizeOf :: LineRasterizationModeEXT -> Int

alignment :: LineRasterizationModeEXT -> Int

peekElemOff :: Ptr LineRasterizationModeEXT -> Int -> IO LineRasterizationModeEXT

pokeElemOff :: Ptr LineRasterizationModeEXT -> Int -> LineRasterizationModeEXT -> IO ()

peekByteOff :: Ptr b -> Int -> IO LineRasterizationModeEXT

pokeByteOff :: Ptr b -> Int -> LineRasterizationModeEXT -> IO ()

peek :: Ptr LineRasterizationModeEXT -> IO LineRasterizationModeEXT

poke :: Ptr LineRasterizationModeEXT -> LineRasterizationModeEXT -> IO ()

Zero LineRasterizationModeEXT

Defined in Vulkan.Extensions.VK_EXT_line_rasterization

Methods

zero :: LineRasterizationModeEXT

type EXT_LINE_RASTERIZATION_SPEC_VERSION = 1

pattern EXT_LINE_RASTERIZATION_SPEC_VERSION :: forall a. Integral a => a

type EXT_LINE_RASTERIZATION_EXTENSION_NAME = "VK_EXT_line_rasterization"

pattern EXT_LINE_RASTERIZATION_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a