Modulevulkan-3.27GHC2021

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: 2
Ratification Status: Ratified
Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or

Vulkan Version 1.1 and

VK_KHR_create_renderpass2 or Vulkan Version 1.2

API Interactions

Interacts with VK_VERSION_1_3
Interacts with VK_KHR_dynamic_rendering
Interacts with VK_KHR_format_feature_flags2

SPIR-V Dependencies

SPV_KHR_fragment_shading_rate

Contact

Tobias Hector @tobski%0A*Here describe the issue or question you have about the VK_KHR_fragment_shading_rate extension*

Extension Proposal

VK_KHR_fragment_shading_rate

Other Extension Metadata

Last Modified Date: 2021-09-30

Interactions and External Dependencies

This extension provides API support for GL_EXT_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
Arseny Kapoulkine, Roblox
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://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#primsrast-fragment-shading-rate-pipeline, which allows the specification of a rate per-draw.
https://registry.khronos.org/vulkan/specs/latest/html/vkspec.html#primsrast-fragment-shading-rate-primitive, which allows the specification of a rate per primitive, specified during shading.
https://registry.khronos.org/vulkan/specs/latest/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.

Version History

Revision 1, 2020-05-06 (Tobias Hector)
- Initial revision

Revision 2, 2021-09-30 (Jon Leech)
- Add interaction with VK_KHR_format_feature_flags2 to vk.xml

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.

9 types
2 values

Packagevulkan-3.27
Exports19
LanguageGHC2021
LicenceBSD-3-Clause
SourceVK_KHR_fragment_shading_rate.hs

valuecmdSetFragmentShadingRateKHR

:: 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 and combiner operation dynamically for a command buffer

Description

This command sets the pipeline fragment shading rate and combiner operation for subsequent drawing commands when drawing using shader objects, or when the graphics pipeline is created with DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR set in PipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the PipelineFragmentShadingRateStateCreateInfoKHR values used to create the currently active pipeline.

Valid Usage

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

If the pipelineFragmentShadingRate feature is not enabled, pFragmentSize->height must be 1
One of the pipelineFragmentShadingRate, primitiveFragmentShadingRate, or attachmentFragmentShadingRate features 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
Each 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 QUEUE_GRAPHICS_BIT operations
This command must only be called outside of a video coding scope

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	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Both	Outside	VK_QUEUE_GRAPHICS_BIT	State

Conditional Rendering

vkCmdSetFragmentShadingRateKHR is not affected by conditional rendering

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 application 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}

sampleCounts

fragmentSize

{2,2}

{2,1}

{1,1}

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

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.

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

Failure

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

Structure Chaining

Extends the structure

SubpassDescription2

Constructors

FragmentShadingRateAttachmentInfoKHR
- 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.

Instances4Show, FromCStruct, ToCStruct, Zero

Show FragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct FragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct FragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero FragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

datadata 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 controlling 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.

Structure Chaining

Extends the structure

GraphicsPipelineCreateInfo

Constructors

PipelineFragmentShadingRateStateCreateInfoKHR
- 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.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show PipelineFragmentShadingRateStateCreateInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable PipelineFragmentShadingRateStateCreateInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct PipelineFragmentShadingRateStateCreateInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct PipelineFragmentShadingRateStateCreateInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero PipelineFragmentShadingRateStateCreateInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

datadata 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. If the application wishes to use a Device with any features described by PhysicalDeviceFragmentShadingRateFeaturesKHR, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Structure Chaining

Extends the structures

Constructors

PhysicalDeviceFragmentShadingRateFeaturesKHR
- 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.

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero

Eq PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Show PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero PhysicalDeviceFragmentShadingRateFeaturesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

datadata PhysicalDeviceFragmentShadingRatePropertiesKHR

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

Description

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.

Structure Chaining

Extends the structure

PhysicalDeviceProperties2

Constructors

PhysicalDeviceFragmentShadingRatePropertiesKHR
- 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 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.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show PhysicalDeviceFragmentShadingRatePropertiesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable PhysicalDeviceFragmentShadingRatePropertiesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct PhysicalDeviceFragmentShadingRatePropertiesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct PhysicalDeviceFragmentShadingRatePropertiesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero PhysicalDeviceFragmentShadingRatePropertiesKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

datadata PhysicalDeviceFragmentShadingRateKHR

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

Valid Usage (Implicit)

Constructors

PhysicalDeviceFragmentShadingRateKHR
- 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.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show PhysicalDeviceFragmentShadingRateKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable PhysicalDeviceFragmentShadingRateKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct PhysicalDeviceFragmentShadingRateKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct PhysicalDeviceFragmentShadingRateKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero PhysicalDeviceFragmentShadingRateKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

datadata RenderingFragmentShadingRateAttachmentInfoKHR

VkRenderingFragmentShadingRateAttachmentInfoKHR - Structure specifying fragment shading rate attachment information

Description

This structure can be included in the pNext chain of RenderingInfo to define a fragment shading rate attachment. If imageView is NULL_HANDLE, 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 imageView is not NULL_HANDLE, layout must be IMAGE_LAYOUT_GENERAL or IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

If imageView is not NULL_HANDLE, it must have been created with the IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR usage flag set
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be a power of two value
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.width
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.width must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.width
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be a power of two value
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSize.height
If imageView is not NULL_HANDLE, shadingRateAttachmentTexelSize.height must be greater than or equal to minFragmentShadingRateAttachmentTexelSize.height
If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.width and shadingRateAttachmentTexelSize.height must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio
If imageView is not NULL_HANDLE, the quotient of shadingRateAttachmentTexelSize.height and shadingRateAttachmentTexelSize.width must be less than or equal to maxFragmentShadingRateAttachmentTexelSizeAspectRatio

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_RENDERING_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR

If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
imageLayout must be a valid ImageLayout value

Structure Chaining

Extends the structure

RenderingInfo

Constructors

RenderingFragmentShadingRateAttachmentInfoKHR
- imageView :: ImageView
  imageView is the image view that will be used as a fragment shading rate attachment.
- imageLayout :: ImageLayout
  imageLayout is the layout that imageView will be in during rendering.
- shadingRateAttachmentTexelSize :: Extent2D
  shadingRateAttachmentTexelSize specifies the number of pixels corresponding to each texel in imageView.

Instances5Show, Storable, FromCStruct, ToCStruct, Zero

Show RenderingFragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable RenderingFragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
FromCStruct RenderingFragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
ToCStruct RenderingFragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero RenderingFragmentShadingRateAttachmentInfoKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

newtypenewtype FragmentShadingRateCombinerOpKHR

VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined

Description

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

FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR specifies a combiner operation of combine(Axy,Bxy) = Bxy.
FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR specifies a combiner operation of combine(Axy,Bxy) = min(Axy,Bxy).
FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR specifies a combiner operation of combine(Axy,Bxy) = max(Axy,Bxy).
FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR specifies a combiner operation of combine(Axy,Bxy) = Axy*Bxy.

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.

Constructors

FragmentShadingRateCombinerOpKHR Int32

Instances6Eq, Ord, Read, Show, Storable, Zero

Eq FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Ord FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Read FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Show FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Storable FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate
Zero FragmentShadingRateCombinerOpKHRDefined in vulkan-3.27 · Vulkan.Extensions.VK_KHR_fragment_shading_rate

patternpattern FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR :: FragmentShadingRateCombinerOpKHR

patternpattern FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR :: FragmentShadingRateCombinerOpKHR

patternpattern FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR :: FragmentShadingRateCombinerOpKHR

patternpattern FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR :: FragmentShadingRateCombinerOpKHR

patternpattern FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR :: FragmentShadingRateCombinerOpKHR

typetype KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION = 2

patternpattern KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION :: Integral a => a

typetype KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME = "VK_KHR_fragment_shading_rate"

patternpattern KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME :: (Eq a, IsString a) => a

Description

Valid Usage

Valid Usage (Implicit)

Host Synchronization

Command Properties

Conditional Rendering

See Also

Description

Valid Usage (Implicit)

Return Codes

See Also

Description

Valid Usage

Valid Usage (Implicit)

Structure Chaining

See Also

Constructors

Description

Structure Chaining

See Also

Constructors

Members

Description

Structure Chaining

See Also

Constructors

Description

Structure Chaining

See Also

Constructors

Valid Usage (Implicit)

See Also

Constructors

Description

Valid Usage

Valid Usage (Implicit)

Structure Chaining

See Also

Constructors

Description

See Also

Constructors