Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_NV_fragment_coverage_to_color

Description

Name

VK_NV_fragment_coverage_to_color - device extension

VK_NV_fragment_coverage_to_color

Name String: VK_NV_fragment_coverage_to_color

Extension Type

Device extension

Registered Extension Number

150

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies; Contact

Jeff Bolz @jeffbolznv%0A*Here describe the issue or question you have about the VK_NV_fragment_coverage_to_color extension*

Other Extension Metadata

Last Modified Date: 2017-05-21

Contributors

Jeff Bolz, NVIDIA

Description

This extension allows the fragment coverage value, represented as an integer bitmask, to be substituted for a color output being written to a single-component color attachment with integer components (e.g. FORMAT_R8_UINT). The functionality provided by this extension is different from simply writing the SampleMask fragment shader output, in that the coverage value written to the framebuffer is taken after stencil test and depth test, as well as after fragment operations such as alpha-to-coverage.

This functionality may be useful for deferred rendering algorithms, where the second pass needs to know which samples belong to which original fragments.

New Structures

Extending PipelineMultisampleStateCreateInfo:
- PipelineCoverageToColorStateCreateInfoNV

New Bitmasks

PipelineCoverageToColorStateCreateFlagsNV

New Enum Constants

NV_FRAGMENT_COVERAGE_TO_COLOR_EXTENSION_NAME

Version History

Revision 1, 2017-05-21 (Jeff Bolz)
- Internal revisions

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

data PipelineCoverageToColorStateCreateInfoNV = PipelineCoverageToColorStateCreateInfoNV {
}
newtype PipelineCoverageToColorStateCreateFlagsNV = PipelineCoverageToColorStateCreateFlagsNV Flags
type NV_FRAGMENT_COVERAGE_TO_COLOR_SPEC_VERSION = 1
pattern NV_FRAGMENT_COVERAGE_TO_COLOR_SPEC_VERSION :: forall a. Integral a => a
type NV_FRAGMENT_COVERAGE_TO_COLOR_EXTENSION_NAME = "VK_NV_fragment_coverage_to_color"
pattern NV_FRAGMENT_COVERAGE_TO_COLOR_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PipelineCoverageToColorStateCreateInfoNV Source #

VkPipelineCoverageToColorStateCreateInfoNV - Structure specifying whether fragment coverage replaces a color

Description

If the pNext chain of PipelineMultisampleStateCreateInfo includes a PipelineCoverageToColorStateCreateInfoNV structure, then that structure controls whether the fragment coverage is substituted for a fragment color output and, if so, which output is replaced.

If coverageToColorEnable is TRUE, the coverage mask replaces the first component of the color value corresponding to the fragment shader output location with Location equal to coverageToColorLocation and Index equal to zero. If the color attachment format has fewer bits than the coverage mask, the low bits of the sample coverage mask are taken without any clamping. If the color attachment format has more bits than the coverage mask, the high bits of the sample coverage mask are filled with zeros.

If coverageToColorEnable is FALSE, these operations are skipped. If this structure is not included in the pNext chain, it is as if coverageToColorEnable is FALSE.

Valid Usage

If coverageToColorEnable is TRUE, then the render pass subpass indicated by GraphicsPipelineCreateInfo::renderPass and GraphicsPipelineCreateInfo::subpass must have a color attachment at the location selected by coverageToColorLocation, with a Format of FORMAT_R8_UINT, FORMAT_R8_SINT, FORMAT_R16_UINT, FORMAT_R16_SINT, FORMAT_R32_UINT, or FORMAT_R32_SINT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_COVERAGE_TO_COLOR_STATE_CREATE_INFO_NV

flags must be 0

PipelineCoverageToColorStateCreateInfoNV
Fields flags :: PipelineCoverageToColorStateCreateFlagsNV `flags` is reserved for future use. coverageToColorEnable :: Bool `coverageToColorEnable` controls whether the fragment coverage value replaces a fragment color output. coverageToColorLocation :: Word32 `coverageToColorLocation` controls which fragment shader color output value is replaced.

Instances

Instances details

Storable PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods sizeOf :: PipelineCoverageToColorStateCreateInfoNV -> Int # alignment :: PipelineCoverageToColorStateCreateInfoNV -> Int # peekElemOff :: Ptr PipelineCoverageToColorStateCreateInfoNV -> Int -> IO PipelineCoverageToColorStateCreateInfoNV # pokeElemOff :: Ptr PipelineCoverageToColorStateCreateInfoNV -> Int -> PipelineCoverageToColorStateCreateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO PipelineCoverageToColorStateCreateInfoNV # pokeByteOff :: Ptr b -> Int -> PipelineCoverageToColorStateCreateInfoNV -> IO () # peek :: Ptr PipelineCoverageToColorStateCreateInfoNV -> IO PipelineCoverageToColorStateCreateInfoNV # poke :: Ptr PipelineCoverageToColorStateCreateInfoNV -> PipelineCoverageToColorStateCreateInfoNV -> IO () #
Show PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods showsPrec :: Int -> PipelineCoverageToColorStateCreateInfoNV -> ShowS # show :: PipelineCoverageToColorStateCreateInfoNV -> String # showList :: [PipelineCoverageToColorStateCreateInfoNV] -> ShowS #
Eq PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods (==) :: PipelineCoverageToColorStateCreateInfoNV -> PipelineCoverageToColorStateCreateInfoNV -> Bool # (/=) :: PipelineCoverageToColorStateCreateInfoNV -> PipelineCoverageToColorStateCreateInfoNV -> Bool #
FromCStruct PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods peekCStruct :: Ptr PipelineCoverageToColorStateCreateInfoNV -> IO PipelineCoverageToColorStateCreateInfoNV Source #
ToCStruct PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods withCStruct :: PipelineCoverageToColorStateCreateInfoNV -> (Ptr PipelineCoverageToColorStateCreateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr PipelineCoverageToColorStateCreateInfoNV -> PipelineCoverageToColorStateCreateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr PipelineCoverageToColorStateCreateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PipelineCoverageToColorStateCreateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PipelineCoverageToColorStateCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods zero :: PipelineCoverageToColorStateCreateInfoNV Source #

newtype PipelineCoverageToColorStateCreateFlagsNV Source #

VkPipelineCoverageToColorStateCreateFlagsNV - Reserved for future use

Description

PipelineCoverageToColorStateCreateFlagsNV is a bitmask type for setting a mask, but is currently reserved for future use.

Storable PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods sizeOf :: PipelineCoverageToColorStateCreateFlagsNV -> Int # alignment :: PipelineCoverageToColorStateCreateFlagsNV -> Int # peekElemOff :: Ptr PipelineCoverageToColorStateCreateFlagsNV -> Int -> IO PipelineCoverageToColorStateCreateFlagsNV # pokeElemOff :: Ptr PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV -> IO () # peekByteOff :: Ptr b -> Int -> IO PipelineCoverageToColorStateCreateFlagsNV # pokeByteOff :: Ptr b -> Int -> PipelineCoverageToColorStateCreateFlagsNV -> IO () # peek :: Ptr PipelineCoverageToColorStateCreateFlagsNV -> IO PipelineCoverageToColorStateCreateFlagsNV # poke :: Ptr PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> IO () #
Bits PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods (.&.) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV # (.\|.) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV # xor :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV # complement :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV # shift :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # rotate :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # zeroBits :: PipelineCoverageToColorStateCreateFlagsNV # bit :: Int -> PipelineCoverageToColorStateCreateFlagsNV # setBit :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # clearBit :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # complementBit :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # testBit :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> Bool # bitSizeMaybe :: PipelineCoverageToColorStateCreateFlagsNV -> Maybe Int # bitSize :: PipelineCoverageToColorStateCreateFlagsNV -> Int # isSigned :: PipelineCoverageToColorStateCreateFlagsNV -> Bool # shiftL :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # unsafeShiftL :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # shiftR :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # unsafeShiftR :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # rotateL :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # rotateR :: PipelineCoverageToColorStateCreateFlagsNV -> Int -> PipelineCoverageToColorStateCreateFlagsNV # popCount :: PipelineCoverageToColorStateCreateFlagsNV -> Int #
FiniteBits PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods finiteBitSize :: PipelineCoverageToColorStateCreateFlagsNV -> Int # countLeadingZeros :: PipelineCoverageToColorStateCreateFlagsNV -> Int # countTrailingZeros :: PipelineCoverageToColorStateCreateFlagsNV -> Int #
Read PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods readsPrec :: Int -> ReadS PipelineCoverageToColorStateCreateFlagsNV # readList :: ReadS [PipelineCoverageToColorStateCreateFlagsNV] # readPrec :: ReadPrec PipelineCoverageToColorStateCreateFlagsNV # readListPrec :: ReadPrec [PipelineCoverageToColorStateCreateFlagsNV] #
Show PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods showsPrec :: Int -> PipelineCoverageToColorStateCreateFlagsNV -> ShowS # show :: PipelineCoverageToColorStateCreateFlagsNV -> String # showList :: [PipelineCoverageToColorStateCreateFlagsNV] -> ShowS #
Eq PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods (==) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool # (/=) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool #
Ord PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods compare :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Ordering # (<) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool # (<=) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool # (>) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool # (>=) :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> Bool # max :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV # min :: PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV -> PipelineCoverageToColorStateCreateFlagsNV #
Zero PipelineCoverageToColorStateCreateFlagsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_fragment_coverage_to_color Methods zero :: PipelineCoverageToColorStateCreateFlagsNV Source #