Vulkan.Extensions.VK_KHR_fragment_shading_rate

Name

VK_KHR_fragment_shading_rate - device extension

VK_KHR_fragment_shading_rate

Name String

VK_KHR_fragment_shading_rate

Extension Type

Device extension

Registered Extension Number

227

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_create_renderpass2
• Requires VK_KHR_get_physical_device_properties2

Contact

• Tobias Hector https://github.com/KhronosGroup/Vulkan-Docs/issues/new?title=VK_KHR_fragment_shading_rate:%20&body=@tobski%20

Other Extension Metadata

Last Modified Date

2020-05-06

Interactions and External Dependencies

• This extension requires SPV_KHR_fragment_shading_rate.

Contributors

• Tobias Hector, AMD
• Guennadi Riguer, AMD
• Matthaeus Chajdas, AMD
• Pat Brown, Nvidia
• Matthew Netsch, Qualcomm
• Slawomir Grajewski, Intel
• Jan-Harald Fredriksen, Arm
• Jeff Bolz, Nvidia
• Contributors to the VK_NV_shading_rate_image specification
• Contributors to the VK_EXT_fragment_density_map specification

Description

This extension adds the ability to change the rate at which fragments are shaded. Rather than the usual single fragment invocation for each pixel covered by a primitive, multiple pixels can be shaded by a single fragment shader invocation.

Up to three methods are available to the application to change the fragment shading rate:

• https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#primsrast-fragment-shading-rate-pipeline, which allows the specification of a rate per-draw.
• https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#primsrast-fragment-shading-rate-primitive, which allows the specification of a rate per primitive, specified during shading.
• https://www.khronos.org/registry/vulkan/specs/1.2-extensions/html/vkspec.html#primsrast-fragment-shading-rate-attachment, which allows the specification of a rate per-region of the framebuffer, specified in a specialized image attachment.

Additionally, these rates can all be specified and combined in order to adjust the overall detail in the image at each point.

This functionality can be used to focus shading efforts where higher levels of detail are needed in some parts of a scene compared to others. This can be particularly useful in high resolution rendering, or for XR contexts.

This extension also adds support for the SPV_KHR_fragment_shading_rate extension which enables setting the primitive fragment shading rate, and allows querying the final shading rate from a fragment shader.

New Commands

• cmdSetFragmentShadingRateKHR

• getPhysicalDeviceFragmentShadingRatesKHR

New Structures

• PhysicalDeviceFragmentShadingRateKHR

• Extending GraphicsPipelineCreateInfo:

  • PipelineFragmentShadingRateStateCreateInfoKHR

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceFragmentShadingRateFeaturesKHR

• Extending PhysicalDeviceProperties2:

  • PhysicalDeviceFragmentShadingRatePropertiesKHR

• Extending SubpassDescription2:

  • FragmentShadingRateAttachmentInfoKHR

New Enums

• FragmentShadingRateCombinerOpKHR

New Enum Constants

• KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME

• KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION

• Extending AccessFlagBits:

  • ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR

• Extending DynamicState:

  • DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR

• Extending FormatFeatureFlagBits:

  • FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

• Extending ImageLayout:

  • IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

• Extending ImageUsageFlagBits:

  • IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

• Extending PipelineStageFlagBits:

  • PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

• Extending StructureType:

  • STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR
  • STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
  • STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR

Version History

• Revision 1, 2020-05-06 (Tobias Hector)

  • Initial revision

See Also

FragmentShadingRateAttachmentInfoKHR, FragmentShadingRateCombinerOpKHR, PhysicalDeviceFragmentShadingRateFeaturesKHR, PhysicalDeviceFragmentShadingRateKHR, PhysicalDeviceFragmentShadingRatePropertiesKHR, PipelineFragmentShadingRateStateCreateInfoKHR, cmdSetFragmentShadingRateKHR, getPhysicalDeviceFragmentShadingRatesKHR

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

cmdSetFragmentShadingRateKHR

Arguments

:: forall io. MonadIO io

=> CommandBuffer

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

-> ("fragmentSize" ::: Extent2D)

pFragmentSize specifies the pipeline fragment shading rate for subsequent drawing commands.

-> ("combinerOps" ::: (FragmentShadingRateCombinerOpKHR, FragmentShadingRateCombinerOpKHR))

combinerOps specifies a FragmentShadingRateCombinerOpKHR determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by subsequent drawing commands.

-> io ()

vkCmdSetFragmentShadingRateKHR - Set pipeline fragment shading rate dynamically

Valid Usage

• If pipelineFragmentShadingRate is not enabled, pFragmentSize->width must be 1

• If pipelineFragmentShadingRate is not enabled, pFragmentSize->height must be 1
• One of pipelineFragmentShadingRate, primitiveFragmentShadingRate, or attachmentFragmentShadingRate must be enabled
• If the primitiveFragmentShadingRate feature is not enabled, combinerOps[0] must be FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR
• If the attachmentFragmentShadingRate feature is not enabled, combinerOps[1] must be FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR
• If the fragmentSizeNonTrivialCombinerOps limit is not supported, elements of combinerOps must be either FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR or FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR
• pFragmentSize->width must be greater than or equal to 1
• pFragmentSize->height must be greater than or equal to 1
• pFragmentSize->width must be a power-of-two value
• pFragmentSize->height must be a power-of-two value
• pFragmentSize->width must be less than or equal to 4
• pFragmentSize->height must be less than or equal to 4

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pFragmentSize must be a valid pointer to a valid Extent2D structure
• Any given element of combinerOps must be a valid FragmentShadingRateCombinerOpKHR value
• 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

CommandBuffer, Extent2D, FragmentShadingRateCombinerOpKHR

getPhysicalDeviceFragmentShadingRatesKHR

Arguments

:: forall io. MonadIO io

=> PhysicalDevice

physicalDevice is the handle to the physical device whose properties will be queried.

-> io (Result, "fragmentShadingRates" ::: Vector PhysicalDeviceFragmentShadingRateKHR)

vkGetPhysicalDeviceFragmentShadingRatesKHR - Get available shading rates for a physical device

Description

If pFragmentShadingRates is NULL, then the number of fragment shading rates available is returned in pFragmentShadingRateCount. Otherwise, pFragmentShadingRateCount must point to a variable set by the user to the number of elements in the pFragmentShadingRates array, and on return the variable is overwritten with the number of structures actually written to pFragmentShadingRates. If pFragmentShadingRateCount is less than the number of fragment shading rates available, at most pFragmentShadingRateCount structures will be written, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available fragment shading rates were returned.

The returned array of fragment shading rates must be ordered from largest fragmentSize.width value to smallest, and each set of fragment shading rates with the same fragmentSize.width value must be ordered from largest fragmentSize.height to smallest. Any two entries in the array must not have the same fragmentSize values.

For any entry in the array, the following rules also apply:

• The value of fragmentSize.width must be less than or equal to maxFragmentSize.width.
• The value of fragmentSize.width must be greater than or equal to 1.
• The value of fragmentSize.width must be a power-of-two.
• The value of fragmentSize.height must be less than or equal to maxFragmentSize.height.
• The value of fragmentSize.height must be greater than or equal to 1.
• The value of fragmentSize.height must be a power-of-two.
• The highest sample count in sampleCounts must be less than or equal to maxFragmentShadingRateRasterizationSamples.
• The product of fragmentSize.width, fragmentSize.height, and the highest sample count in sampleCounts must be less than or equal to maxFragmentShadingRateCoverageSamples.

Implementations must support at least the following shading rates:

sampleCounts	fragmentSize
SAMPLE_COUNT_1_BIT | SAMPLE_COUNT_4_BIT	{2,2}
SAMPLE_COUNT_1_BIT | SAMPLE_COUNT_4_BIT	{2,1}
~0	{1,1}

If framebufferColorSampleCounts, includes SAMPLE_COUNT_2_BIT, the required rates must also include SAMPLE_COUNT_2_BIT.

Note

Including the {1,1} fragment size is done for completeness; it has no actual effect on the support of rendering without setting the fragment size. All sample counts and render pass transforms are supported for this rate.

The returned set of fragment shading rates must be returned in the native (rotated) coordinate system. For rasterization using render pass transform not equal to SURFACE_TRANSFORM_IDENTITY_BIT_KHR, the application must transform the returned fragment shading rates into the current (unrotated) coordinate system to get the supported rates for that transform.

Note

For example, consider an implementation returning support for 4x2, but not 2x4 in the set of supported fragment shading rates. This means that for transforms SURFACE_TRANSFORM_ROTATE_90_BIT_KHR and SURFACE_TRANSFORM_ROTATE_270_BIT_KHR, 2x4 is a supported rate, but 4x2 is an unsupported rate.

Valid Usage (Implicit)

• physicalDevice must be a valid PhysicalDevice handle

• pFragmentShadingRateCount must be a valid pointer to a uint32_t value
• If the value referenced by pFragmentShadingRateCount is not 0, and pFragmentShadingRates is not NULL, pFragmentShadingRates must be a valid pointer to an array of pFragmentShadingRateCount PhysicalDeviceFragmentShadingRateKHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY

See Also

PhysicalDevice, PhysicalDeviceFragmentShadingRateKHR

data FragmentShadingRateAttachmentInfoKHR

VkFragmentShadingRateAttachmentInfoKHR - Structure specifying a fragment shading rate attachment for a subpass

Description

If no shading rate attachment is specified, or if this structure is not specified, the implementation behaves as if a valid shading rate attachment was specified with all texels specifying a single pixel per fragment.

Valid Usage

• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, its layout member must be equal to IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be a power of two value
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.width
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.width must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.width
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be a power of two value
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.height
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, shadingRateAttachmentTexelSize.height must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.height
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, the quotient of shadingRateAttachmentTexelSize.width and shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
• If pFragmentShadingRateAttachment is not NULL and its attachment member is not ATTACHMENT_UNUSED, the quotient of shadingRateAttachmentTexelSize.height and shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR

• If pFragmentShadingRateAttachment is not NULL, pFragmentShadingRateAttachment must be a valid pointer to a valid AttachmentReference2 structure

See Also

AttachmentReference2, Extent2D, StructureType

Constructors

FragmentShadingRateAttachmentInfoKHR

Fields

• fragmentShadingRateAttachment :: Maybe (SomeStruct AttachmentReference2)

  pFragmentShadingRateAttachment is NULL or a pointer to a AttachmentReference2 structure defining the fragment shading rate attachment for this subpass.

• shadingRateAttachmentTexelSize :: Extent2D

  shadingRateAttachmentTexelSize specifies the size of the portion of the framebuffer corresponding to each texel in pFragmentShadingRateAttachment.

Instances

Show FragmentShadingRateAttachmentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> FragmentShadingRateAttachmentInfoKHR -> ShowS

show :: FragmentShadingRateAttachmentInfoKHR -> String

showList :: [FragmentShadingRateAttachmentInfoKHR] -> ShowS

FromCStruct FragmentShadingRateAttachmentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

peekCStruct :: Ptr FragmentShadingRateAttachmentInfoKHR -> IO FragmentShadingRateAttachmentInfoKHR

ToCStruct FragmentShadingRateAttachmentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

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

pokeCStruct :: Ptr FragmentShadingRateAttachmentInfoKHR -> FragmentShadingRateAttachmentInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr FragmentShadingRateAttachmentInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero FragmentShadingRateAttachmentInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: FragmentShadingRateAttachmentInfoKHR

data PipelineFragmentShadingRateStateCreateInfoKHR

VkPipelineFragmentShadingRateStateCreateInfoKHR - Structure specifying parameters controlling the fragment shading rate

Description

If the pNext chain of GraphicsPipelineCreateInfo includes a PipelineFragmentShadingRateStateCreateInfoKHR structure, then that structure includes parameters that control the pipeline fragment shading rate.

If this structure is not present, fragmentSize is considered to be equal to (1,1), and both elements of combinerOps are considered to be equal to FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR

• Any given element of combinerOps must be a valid FragmentShadingRateCombinerOpKHR value

See Also

Extent2D, FragmentShadingRateCombinerOpKHR, StructureType

Constructors

PipelineFragmentShadingRateStateCreateInfoKHR

Fields

• fragmentSize :: Extent2D

  fragmentSize specifies a Extent2D structure containing the fragment size used to define the pipeline fragment shading rate for drawing commands using this pipeline.

• combinerOps :: (FragmentShadingRateCombinerOpKHR, FragmentShadingRateCombinerOpKHR)

  combinerOps specifies a FragmentShadingRateCombinerOpKHR value determining how the pipeline, primitive, and attachment shading rates are combined for fragments generated by drawing commands using the created pipeline.

Instances

Show PipelineFragmentShadingRateStateCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> PipelineFragmentShadingRateStateCreateInfoKHR -> ShowS

show :: PipelineFragmentShadingRateStateCreateInfoKHR -> String

showList :: [PipelineFragmentShadingRateStateCreateInfoKHR] -> ShowS

Storable PipelineFragmentShadingRateStateCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

sizeOf :: PipelineFragmentShadingRateStateCreateInfoKHR -> Int

alignment :: PipelineFragmentShadingRateStateCreateInfoKHR -> Int

peekElemOff :: Ptr PipelineFragmentShadingRateStateCreateInfoKHR -> Int -> IO PipelineFragmentShadingRateStateCreateInfoKHR

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

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

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

peek :: Ptr PipelineFragmentShadingRateStateCreateInfoKHR -> IO PipelineFragmentShadingRateStateCreateInfoKHR

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

FromCStruct PipelineFragmentShadingRateStateCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

peekCStruct :: Ptr PipelineFragmentShadingRateStateCreateInfoKHR -> IO PipelineFragmentShadingRateStateCreateInfoKHR

ToCStruct PipelineFragmentShadingRateStateCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

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

pokeCStruct :: Ptr PipelineFragmentShadingRateStateCreateInfoKHR -> PipelineFragmentShadingRateStateCreateInfoKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PipelineFragmentShadingRateStateCreateInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PipelineFragmentShadingRateStateCreateInfoKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: PipelineFragmentShadingRateStateCreateInfoKHR

data PhysicalDeviceFragmentShadingRateFeaturesKHR

VkPhysicalDeviceFragmentShadingRateFeaturesKHR - Structure indicating support for variable rate fragment shading

Members

This structure describes the following features:

Description

If the PhysicalDeviceFragmentShadingRateFeaturesKHR 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. PhysicalDeviceFragmentShadingRateFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

PhysicalDeviceFragmentShadingRateFeaturesKHR

Fields

• pipelineFragmentShadingRate :: Bool

  pipelineFragmentShadingRate indicates that the implementation supports the pipeline fragment shading rate.

• primitiveFragmentShadingRate :: Bool

  primitiveFragmentShadingRate indicates that the implementation supports the primitive fragment shading rate.

• attachmentFragmentShadingRate :: Bool

  attachmentFragmentShadingRate indicates that the implementation supports the attachment fragment shading rate.

Instances

Eq PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

(==) :: PhysicalDeviceFragmentShadingRateFeaturesKHR -> PhysicalDeviceFragmentShadingRateFeaturesKHR -> Bool

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

Show PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> PhysicalDeviceFragmentShadingRateFeaturesKHR -> ShowS

show :: PhysicalDeviceFragmentShadingRateFeaturesKHR -> String

showList :: [PhysicalDeviceFragmentShadingRateFeaturesKHR] -> ShowS

Storable PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

sizeOf :: PhysicalDeviceFragmentShadingRateFeaturesKHR -> Int

alignment :: PhysicalDeviceFragmentShadingRateFeaturesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceFragmentShadingRateFeaturesKHR -> Int -> IO PhysicalDeviceFragmentShadingRateFeaturesKHR

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

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

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

peek :: Ptr PhysicalDeviceFragmentShadingRateFeaturesKHR -> IO PhysicalDeviceFragmentShadingRateFeaturesKHR

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

FromCStruct PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

peekCStruct :: Ptr PhysicalDeviceFragmentShadingRateFeaturesKHR -> IO PhysicalDeviceFragmentShadingRateFeaturesKHR

ToCStruct PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

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

pokeCStruct :: Ptr PhysicalDeviceFragmentShadingRateFeaturesKHR -> PhysicalDeviceFragmentShadingRateFeaturesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceFragmentShadingRateFeaturesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceFragmentShadingRateFeaturesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: PhysicalDeviceFragmentShadingRateFeaturesKHR

data PhysicalDeviceFragmentShadingRatePropertiesKHR

VkPhysicalDeviceFragmentShadingRatePropertiesKHR - Structure describing variable fragment shading rate limits that can be supported by an implementation

Description

Note

Multiplication of the combiner rates using the fragment width/height in linear space is equivalent to an addition of those values in log2 space. Some implementations inadvertently implemented an addition in linear space due to unclear requirements originating outside of this specification. This resulted in fragmentShadingRateStrictMultiplyCombiner being added. Fortunately, this only affects situations where a rate of 1 in either dimension is combined with another rate of 1. All other combinations result in the exact same result as if multiplication was performed in linear space due to the clamping logic, and the fact that both the sum and product of 2 and 2 are equal. In many cases, this limit will not affect the correct operation of applications.

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

These properties are related to fragment shading rates.

Valid Usage (Implicit)

See Also

Bool32, Extent2D, SampleCountFlagBits, StructureType

Constructors

PhysicalDeviceFragmentShadingRatePropertiesKHR

Fields

• minFragmentShadingRateAttachmentTexelSize :: Extent2D

  minFragmentShadingRateAttachmentTexelSize indicates minimum supported width and height of the portion of the framebuffer corresponding to each texel in a fragment shading rate attachment. Each value must be less than or equal to the values in maxFragmentShadingRateAttachmentTexelSize. Each value must be a power-of-two. It must be (0,0) if the attachmentFragmentShadingRate feature is not supported.

• maxFragmentShadingRateAttachmentTexelSize :: Extent2D

  maxFragmentShadingRateAttachmentTexelSize indicates maximum supported width and height of the portion of the framebuffer corresponding to each texel in a fragment shading rate attachment. Each value must be greater than or equal to the values in minFragmentShadingRateAttachmentTexelSize. Each value must be a power-of-two. It must be (0,0) if the attachmentFragmentShadingRate feature is not supported.

• maxFragmentShadingRateAttachmentTexelSizeAspectRatio :: Word32

  maxFragmentShadingRateAttachmentTexelSizeAspectRatio indicates the maximum ratio between the width and height of the portion of the framebuffer corresponding to each texel in a fragment shading rate attachment. maxFragmentShadingRateAttachmentTexelSizeAspectRatio must be a power-of-two value, and must be less than or equal to max(maxFragmentShadingRateAttachmentTexelSize.width / minFragmentShadingRateAttachmentTexelSize.height, maxFragmentShadingRateAttachmentTexelSize.height / minFragmentShadingRateAttachmentTexelSize.width). It must be 0 if the attachmentFragmentShadingRate feature is not supported.

• primitiveFragmentShadingRateWithMultipleViewports :: Bool

  primitiveFragmentShadingRateWithMultipleViewports specifies whether the primitive fragment shading rate can be used when multiple viewports are used. If this value is FALSE, only a single viewport must be used, and applications must not write to the ViewportMaskNV or ViewportIndex built-in when setting PrimitiveShadingRateKHR. It must be FALSE if the shaderOutputViewportIndex feature, the VK_EXT_shader_viewport_index_layer extension, or the geometryShader feature is not supported, or if the primitiveFragmentShadingRate feature is not supported.

• layeredShadingRateAttachments :: Bool

  layeredShadingRateAttachments specifies whether a shading rate attachment image view can be created with multiple layers. If this value is FALSE, when creating an image view with a usage that includes IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR, layerCount must be 1. It must be FALSE if the multiview feature, the shaderOutputViewportIndex feature, the VK_EXT_shader_viewport_index_layer extension, or the geometryShader feature is not supported, or if the attachmentFragmentShadingRate feature is not supported.

• fragmentShadingRateNonTrivialCombinerOps :: Bool

  fragmentShadingRateNonTrivialCombinerOps specifies whether FragmentShadingRateCombinerOpKHR enums other than FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR or FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR can be used. It must be FALSE unless either the primitiveFragmentShadingRate or attachmentFragmentShadingRate feature is supported.

• maxFragmentSize :: Extent2D

  maxFragmentSize indicates the maximum supported width and height of a fragment. Its width and height members must both be power-of-two values. This limit is purely informational, and is not validated.

• maxFragmentSizeAspectRatio :: Word32

  maxFragmentSizeAspectRatio indicates the maximum ratio between the width and height of a fragment. maxFragmentSizeAspectRatio must be a power-of-two value, and must be less than or equal to the maximum of the width and height members of maxFragmentSize. This limit is purely informational, and is not validated.

• maxFragmentShadingRateCoverageSamples :: Word32

  maxFragmentShadingRateCoverageSamples specifies the maximum number of coverage samples supported in a single fragment. maxFragmentShadingRateCoverageSamples must be less than or equal to the product of the width and height members of maxFragmentSize, and the sample count reported by maxFragmentShadingRateRasterizationSamples. maxFragmentShadingRateCoverageSamples must be less than or equal to maxSampleMaskWords × 32 if fragmentShadingRateWithShaderSampleMask is supported. This limit is purely informational, and is not validated.

• maxFragmentShadingRateRasterizationSamples :: SampleCountFlagBits

  maxFragmentShadingRateRasterizationSamples is a SampleCountFlagBits value specifying the maximum sample rate supported when a fragment covers multiple pixels. This limit is purely informational, and is not validated.

• fragmentShadingRateWithShaderDepthStencilWrites :: Bool

  fragmentShadingRateWithShaderDepthStencilWrites specifies whether the implementation supports writing FragDepth or FragStencilRefEXT from a fragment shader for multi-pixel fragments. If this value is FALSE, writing to those built-ins will clamp the fragment shading rate to (1,1).

• fragmentShadingRateWithSampleMask :: Bool

  fragmentShadingRateWithSampleMask specifies whether the the implementation supports setting valid bits of PipelineMultisampleStateCreateInfo::pSampleMask to 0 for multi-pixel fragments. If this value is FALSE, zeroing valid bits in the sample mask will clamp the fragment shading rate to (1,1).

• fragmentShadingRateWithShaderSampleMask :: Bool

  fragmentShadingRateWithShaderSampleMask specifies whether the implementation supports reading or writing SampleMask for multi-pixel fragments. If this value is FALSE, using that built-in will clamp the fragment shading rate to (1,1).

• fragmentShadingRateWithConservativeRasterization :: Bool

  fragmentShadingRateWithConservativeRasterization specifies whether conservative rasterization is supported for multi-pixel fragments. It must be FALSE if VK_EXT_conservative_rasterization is not supported. If this value is FALSE, using conservative rasterization will clamp the fragment shading rate to (1,1).

• fragmentShadingRateWithFragmentShaderInterlock :: Bool

  fragmentShadingRateWithFragmentShaderInterlock specifies whether fragment shader interlock is supported for multi-pixel fragments. It must be FALSE if VK_EXT_fragment_shader_interlock is not supported. If this value is FALSE, using fragment shader interlock will clamp the fragment shading rate to (1,1).

• fragmentShadingRateWithCustomSampleLocations :: Bool

  fragmentShadingRateWithCustomSampleLocations specifies whether custom sample locations are supported for multi-pixel fragments. It must be FALSE if VK_EXT_sample_locations is not supported. If this value is FALSE, using custom sample locations will clamp the fragment shading rate to (1,1).

• fragmentShadingRateStrictMultiplyCombiner :: Bool

  fragmentShadingRateStrictMultiplyCombiner specifies whether FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR accurately performs a multiplication or not. Implementations where this value is FALSE will instead combine rates with an addition. If fragmentShadingRateNonTrivialCombinerOps is FALSE, implementations must report this as FALSE. If fragmentShadingRateNonTrivialCombinerOps is TRUE, implementations should report this as TRUE.

Instances

Show PhysicalDeviceFragmentShadingRatePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> PhysicalDeviceFragmentShadingRatePropertiesKHR -> ShowS

show :: PhysicalDeviceFragmentShadingRatePropertiesKHR -> String

showList :: [PhysicalDeviceFragmentShadingRatePropertiesKHR] -> ShowS

Storable PhysicalDeviceFragmentShadingRatePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

sizeOf :: PhysicalDeviceFragmentShadingRatePropertiesKHR -> Int

alignment :: PhysicalDeviceFragmentShadingRatePropertiesKHR -> Int

peekElemOff :: Ptr PhysicalDeviceFragmentShadingRatePropertiesKHR -> Int -> IO PhysicalDeviceFragmentShadingRatePropertiesKHR

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

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

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

peek :: Ptr PhysicalDeviceFragmentShadingRatePropertiesKHR -> IO PhysicalDeviceFragmentShadingRatePropertiesKHR

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

FromCStruct PhysicalDeviceFragmentShadingRatePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

peekCStruct :: Ptr PhysicalDeviceFragmentShadingRatePropertiesKHR -> IO PhysicalDeviceFragmentShadingRatePropertiesKHR

ToCStruct PhysicalDeviceFragmentShadingRatePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

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

pokeCStruct :: Ptr PhysicalDeviceFragmentShadingRatePropertiesKHR -> PhysicalDeviceFragmentShadingRatePropertiesKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceFragmentShadingRatePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceFragmentShadingRatePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: PhysicalDeviceFragmentShadingRatePropertiesKHR

data PhysicalDeviceFragmentShadingRateKHR

VkPhysicalDeviceFragmentShadingRateKHR - Structure returning information about sample count specific additional multisampling capabilities

Valid Usage (Implicit)

See Also

Extent2D, SampleCountFlags, StructureType, getPhysicalDeviceFragmentShadingRatesKHR

Constructors

PhysicalDeviceFragmentShadingRateKHR

Fields

• sampleCounts :: SampleCountFlags

  sampleCounts is a bitmask of sample counts for which the shading rate described by fragmentSize is supported.

• fragmentSize :: Extent2D

  fragmentSize is a Extent2D describing the width and height of a supported shading rate.

Instances

Show PhysicalDeviceFragmentShadingRateKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> PhysicalDeviceFragmentShadingRateKHR -> ShowS

show :: PhysicalDeviceFragmentShadingRateKHR -> String

showList :: [PhysicalDeviceFragmentShadingRateKHR] -> ShowS

Storable PhysicalDeviceFragmentShadingRateKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

sizeOf :: PhysicalDeviceFragmentShadingRateKHR -> Int

alignment :: PhysicalDeviceFragmentShadingRateKHR -> Int

peekElemOff :: Ptr PhysicalDeviceFragmentShadingRateKHR -> Int -> IO PhysicalDeviceFragmentShadingRateKHR

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

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

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

peek :: Ptr PhysicalDeviceFragmentShadingRateKHR -> IO PhysicalDeviceFragmentShadingRateKHR

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

FromCStruct PhysicalDeviceFragmentShadingRateKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

peekCStruct :: Ptr PhysicalDeviceFragmentShadingRateKHR -> IO PhysicalDeviceFragmentShadingRateKHR

ToCStruct PhysicalDeviceFragmentShadingRateKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

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

pokeCStruct :: Ptr PhysicalDeviceFragmentShadingRateKHR -> PhysicalDeviceFragmentShadingRateKHR -> IO b -> IO b

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

pokeZeroCStruct :: Ptr PhysicalDeviceFragmentShadingRateKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceFragmentShadingRateKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: PhysicalDeviceFragmentShadingRateKHR

newtype FragmentShadingRateCombinerOpKHR

VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined

Description

where combine(Axy,Bxy) is the combine operation, and Axy and Bxy are the inputs to the operation.

If fragmentShadingRateStrictMultiplyCombiner is FALSE, using FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR with values of 1 for both A and B in the same dimension results in the value 2 being produced for that dimension. See the definition of fragmentShadingRateStrictMultiplyCombiner for more information.

These operations are performed in a component-wise fashion.

See Also

PipelineFragmentShadingRateEnumStateCreateInfoNV, PipelineFragmentShadingRateStateCreateInfoKHR, cmdSetFragmentShadingRateEnumNV, cmdSetFragmentShadingRateKHR

Constructors

FragmentShadingRateCombinerOpKHR Int32

Bundled Patterns

pattern FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR :: FragmentShadingRateCombinerOpKHR

FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR specifies a combiner operation of combine(Axy,Bxy) = Axy.

pattern FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR :: FragmentShadingRateCombinerOpKHR

FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR specifies a combiner operation of combine(Axy,Bxy) = Bxy.

pattern FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR :: FragmentShadingRateCombinerOpKHR

FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR specifies a combiner operation of combine(Axy,Bxy) = min(Axy,Bxy).

pattern FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR :: FragmentShadingRateCombinerOpKHR

FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR specifies a combiner operation of combine(Axy,Bxy) = max(Axy,Bxy).

pattern FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR :: FragmentShadingRateCombinerOpKHR

FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR specifies a combiner operation of combine(Axy,Bxy) = Axy*Bxy.

Instances

Eq FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

(==) :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> Bool

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

Ord FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

compare :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> Ordering

(<) :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> Bool

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

(>) :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> Bool

(>=) :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> Bool

max :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR

min :: FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR -> FragmentShadingRateCombinerOpKHR

Read FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

readsPrec :: Int -> ReadS FragmentShadingRateCombinerOpKHR

readList :: ReadS [FragmentShadingRateCombinerOpKHR]

readPrec :: ReadPrec FragmentShadingRateCombinerOpKHR

readListPrec :: ReadPrec [FragmentShadingRateCombinerOpKHR]

Show FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

showsPrec :: Int -> FragmentShadingRateCombinerOpKHR -> ShowS

show :: FragmentShadingRateCombinerOpKHR -> String

showList :: [FragmentShadingRateCombinerOpKHR] -> ShowS

Storable FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

sizeOf :: FragmentShadingRateCombinerOpKHR -> Int

alignment :: FragmentShadingRateCombinerOpKHR -> Int

peekElemOff :: Ptr FragmentShadingRateCombinerOpKHR -> Int -> IO FragmentShadingRateCombinerOpKHR

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

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

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

peek :: Ptr FragmentShadingRateCombinerOpKHR -> IO FragmentShadingRateCombinerOpKHR

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

Zero FragmentShadingRateCombinerOpKHR

Defined in Vulkan.Extensions.VK_KHR_fragment_shading_rate

Methods

zero :: FragmentShadingRateCombinerOpKHR

type KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION = 1

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

type KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME = "VK_KHR_fragment_shading_rate"

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