Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_EXT_line_rasterization

Description

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 https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_EXT_line_rasterization:%20&body=@jeffbolznv%20

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

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

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.

Synopsis

cmdSetLineStippleEXT :: forall io. MonadIO io => CommandBuffer -> ("lineStippleFactor" ::: Word32) -> ("lineStipplePattern" ::: Word16) -> io ()
data PhysicalDeviceLineRasterizationFeaturesEXT = PhysicalDeviceLineRasterizationFeaturesEXT {
- rectangularLines :: Bool
- bresenhamLines :: Bool
- smoothLines :: Bool
- stippledRectangularLines :: Bool
- stippledBresenhamLines :: Bool
- stippledSmoothLines :: Bool
}
data PhysicalDeviceLineRasterizationPropertiesEXT = PhysicalDeviceLineRasterizationPropertiesEXT {
- lineSubPixelPrecisionBits :: Word32
}
data PipelineRasterizationLineStateCreateInfoEXT = PipelineRasterizationLineStateCreateInfoEXT {
}
newtype LineRasterizationModeEXT where
- LineRasterizationModeEXT Int32
- pattern LINE_RASTERIZATION_MODE_DEFAULT_EXT :: LineRasterizationModeEXT
- pattern LINE_RASTERIZATION_MODE_RECTANGULAR_EXT :: LineRasterizationModeEXT
- pattern LINE_RASTERIZATION_MODE_BRESENHAM_EXT :: LineRasterizationModeEXT
- pattern LINE_RASTERIZATION_MODE_RECTANGULAR_SMOOTH_EXT :: 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

Documentation

cmdSetLineStippleEXT Source #

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 the dynamic line width state

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	Pipeline Type
Primary Secondary	Both	Graphics

Members

The members of the PhysicalDeviceLineRasterizationFeaturesEXT structure describe the following features:

Description

If the PhysicalDeviceLineRasterizationFeaturesEXT structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceLineRasterizationFeaturesEXT can also be included in the pNext chain of DeviceCreateInfo to enable the feature.

Valid Usage (Implicit)

Members

The members of the PhysicalDeviceLineRasterizationPropertiesEXT structure describe the following implementation-dependent limits:

Description

If the PhysicalDeviceLineRasterizationPropertiesEXT structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Valid Usage (Implicit)

Eq PhysicalDeviceLineRasterizationPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods (==) :: PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> Bool # (/=) :: PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> Bool #
Show PhysicalDeviceLineRasterizationPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods showsPrec :: Int -> PhysicalDeviceLineRasterizationPropertiesEXT -> ShowS # show :: PhysicalDeviceLineRasterizationPropertiesEXT -> String # showList :: [PhysicalDeviceLineRasterizationPropertiesEXT] -> ShowS #
Storable PhysicalDeviceLineRasterizationPropertiesEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods peekCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO PhysicalDeviceLineRasterizationPropertiesEXT Source #
ToCStruct PhysicalDeviceLineRasterizationPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods withCStruct :: PhysicalDeviceLineRasterizationPropertiesEXT -> (Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> PhysicalDeviceLineRasterizationPropertiesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceLineRasterizationPropertiesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceLineRasterizationPropertiesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods zero :: PhysicalDeviceLineRasterizationPropertiesEXT Source #

data PipelineRasterizationLineStateCreateInfoEXT Source #

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

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

Eq PhysicalDeviceLineRasterizationFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods (==) :: PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> Bool # (/=) :: PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> Bool #
Show PhysicalDeviceLineRasterizationFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods showsPrec :: Int -> PhysicalDeviceLineRasterizationFeaturesEXT -> ShowS # show :: PhysicalDeviceLineRasterizationFeaturesEXT -> String # showList :: [PhysicalDeviceLineRasterizationFeaturesEXT] -> ShowS #
Storable PhysicalDeviceLineRasterizationFeaturesEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods peekCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO PhysicalDeviceLineRasterizationFeaturesEXT Source #
ToCStruct PhysicalDeviceLineRasterizationFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods withCStruct :: PhysicalDeviceLineRasterizationFeaturesEXT -> (Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> PhysicalDeviceLineRasterizationFeaturesEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceLineRasterizationFeaturesEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceLineRasterizationFeaturesEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods zero :: PhysicalDeviceLineRasterizationFeaturesEXT Source #

Eq PipelineRasterizationLineStateCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods (==) :: PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> Bool # (/=) :: PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> Bool #
Show PipelineRasterizationLineStateCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods showsPrec :: Int -> PipelineRasterizationLineStateCreateInfoEXT -> ShowS # show :: PipelineRasterizationLineStateCreateInfoEXT -> String # showList :: [PipelineRasterizationLineStateCreateInfoEXT] -> ShowS #
Storable PipelineRasterizationLineStateCreateInfoEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods peekCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO PipelineRasterizationLineStateCreateInfoEXT Source #
ToCStruct PipelineRasterizationLineStateCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods withCStruct :: PipelineRasterizationLineStateCreateInfoEXT -> (Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> PipelineRasterizationLineStateCreateInfoEXT -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineRasterizationLineStateCreateInfoEXT -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineRasterizationLineStateCreateInfoEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods zero :: PipelineRasterizationLineStateCreateInfoEXT Source #

Eq LineRasterizationModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods (==) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool # (/=) :: LineRasterizationModeEXT -> LineRasterizationModeEXT -> Bool #
Ord LineRasterizationModeEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods readsPrec :: Int -> ReadS LineRasterizationModeEXT # readList :: ReadS [LineRasterizationModeEXT] # readPrec :: ReadPrec LineRasterizationModeEXT # readListPrec :: ReadPrec [LineRasterizationModeEXT] #
Show LineRasterizationModeEXT Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods showsPrec :: Int -> LineRasterizationModeEXT -> ShowS # show :: LineRasterizationModeEXT -> String # showList :: [LineRasterizationModeEXT] -> ShowS #
Storable LineRasterizationModeEXT Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_EXT_line_rasterization Methods zero :: LineRasterizationModeEXT Source #

Name

VK_EXT_line_rasterization

Other Extension Metadata

Description

New Commands

New Structures

New Enums

New Enum Constants

Issues

Version History

See Also

Document Notes

Documentation

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Members

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

PhysicalDeviceLineRasterizationPropertiesEXT
Fields lineSubPixelPrecisionBits :: Word32 `lineSubPixelPrecisionBits` is the number of bits of subpixel precision in framebuffer coordinates xf and yf when rasterizing line segments.

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.