Package org.lwjgl.vulkan

Class KHRFragmentShadingRate

java.lang.Object

org.lwjgl.vulkan.KHRFragmentShadingRate

public class KHRFragmentShadingRate
extends Object

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:

• Pipeline Fragment Shading Rate, which allows the specification of a rate per-draw.
• Primitive Fragment Shading Rate, which allows the specification of a rate per primitive, specified during shading.
• Attachment Fragment Shading Rate, 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.

VK_KHR_fragment_shading_rate

Name String

VK_KHR_fragment_shading_rate

Extension Type

Device extension

Registered Extension Number

227

Revision

2

Extension and Version Dependencies

VK_KHR_create_renderpass2 or Version 1.2 and VK_KHR_get_physical_device_properties2 or Version 1.1

Contact

• Tobias Hector tobski

Extension Proposal

VK_KHR_fragment_shading_rate

Other Extension Metadata

Last Modified Date

2021-09-30

Interactions and External Dependencies

• This extension requires SPV_KHR_fragment_shading_rate.
• 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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR	Extends VkAccessFlagBits.
static final int	VK_DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR	Extends VkDynamicState.
static final long	VK_FORMAT_FEATURE_2_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR	Extends VkFormatFeatureFlagBits2.
static final int	VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR	Extends VkFormatFeatureFlagBits.
static final int	VK_FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR	VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined
static final int	VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR	VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined
static final int	VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR	VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined
static final int	VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR	VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined
static final int	VK_FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR	VkFragmentShadingRateCombinerOpKHR - Control how fragment shading rates are combined
static final int	VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR	Extends VkImageLayout.
static final int	VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR	Extends VkImageUsageFlagBits.
static final String	VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME	The extension name.
static final int	VK_KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION	The extension specification version.
static final int	VK_PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR	Extends VkPipelineStageFlagBits.
static final int	VK_STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, long pFragmentSize, long combinerOps)	Unsafe version of: CmdSetFragmentShadingRateKHR
static int	nvkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, long pFragmentShadingRateCount, long pFragmentShadingRates)	Unsafe version of: GetPhysicalDeviceFragmentShadingRatesKHR
static void	vkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkExtent2D pFragmentSize, int[] combinerOps)	Array version of: CmdSetFragmentShadingRateKHR
static void	vkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, VkExtent2D pFragmentSize, IntBuffer combinerOps)	Set pipeline fragment shading rate and combiner operation dynamically for a command buffer.
static int	vkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, int[] pFragmentShadingRateCount, VkPhysicalDeviceFragmentShadingRateKHR.Buffer pFragmentShadingRates)	Array version of: GetPhysicalDeviceFragmentShadingRatesKHR
static int	vkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice, IntBuffer pFragmentShadingRateCount, VkPhysicalDeviceFragmentShadingRateKHR.Buffer pFragmentShadingRates)	Get available shading rates for a physical device.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION

public static final int VK_KHR_FRAGMENT_SHADING_RATE_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME

public static final String VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

public static final int VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR

Extends VkImageLayout.

See Also:

• Constant Field Values

VK_DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR

public static final int VK_DYNAMIC_STATE_FRAGMENT_SHADING_RATE_KHR

Extends VkDynamicState.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR

public static final int VK_STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR

public static final int VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_KHR

See Also:

• Constant Field Values

VK_ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR

public static final int VK_ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR

Extends VkAccessFlagBits.

See Also:

• Constant Field Values

VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

public static final int VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

Extends VkImageUsageFlagBits.

See Also:

• Constant Field Values

VK_PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

public static final int VK_PIPELINE_STAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

Extends VkPipelineStageFlagBits.

See Also:

• Constant Field Values

VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

public static final int VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

Extends VkFormatFeatureFlagBits.

See Also:

• Constant Field Values

VK_FORMAT_FEATURE_2_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

public static final long VK_FORMAT_FEATURE_2_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR

Extends VkFormatFeatureFlagBits2.

See Also:

• Constant Field Values

VK_FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR

public static final int VK_FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR

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.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, VkPipelineFragmentShadingRateStateCreateInfoKHR, CmdSetFragmentShadingRateEnumNV, CmdSetFragmentShadingRateKHR

See Also:

• Constant Field Values

VK_FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR

public static final int VK_FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR

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.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, VkPipelineFragmentShadingRateStateCreateInfoKHR, CmdSetFragmentShadingRateEnumNV, CmdSetFragmentShadingRateKHR

See Also:

• Constant Field Values

VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR

public static final int VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MIN_KHR

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.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, VkPipelineFragmentShadingRateStateCreateInfoKHR, CmdSetFragmentShadingRateEnumNV, CmdSetFragmentShadingRateKHR

See Also:

• Constant Field Values

VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR

public static final int VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MAX_KHR

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.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, VkPipelineFragmentShadingRateStateCreateInfoKHR, CmdSetFragmentShadingRateEnumNV, CmdSetFragmentShadingRateKHR

See Also:

• Constant Field Values

VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR

public static final int VK_FRAGMENT_SHADING_RATE_COMBINER_OP_MUL_KHR

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.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, VkPipelineFragmentShadingRateStateCreateInfoKHR, CmdSetFragmentShadingRateEnumNV, CmdSetFragmentShadingRateKHR

See Also:

• Constant Field Values

Method Details

nvkGetPhysicalDeviceFragmentShadingRatesKHR

public static int nvkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 long pFragmentShadingRateCount,
 long pFragmentShadingRates)

Unsafe version of: GetPhysicalDeviceFragmentShadingRatesKHR

Parameters:

pFragmentShadingRateCount - a pointer to an integer related to the number of fragment shading rates available or queried, as described below.

vkGetPhysicalDeviceFragmentShadingRatesKHR

public static int vkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 IntBuffer pFragmentShadingRateCount,
 @Nullable
 VkPhysicalDeviceFragmentShadingRateKHR.Buffer pFragmentShadingRates)

Get available shading rates for a physical device.

C Specification

To query available shading rates, call:

 VkResult vkGetPhysicalDeviceFragmentShadingRatesKHR(
     VkPhysicalDevice                            physicalDevice,
     uint32_t*                                   pFragmentShadingRateCount,
     VkPhysicalDeviceFragmentShadingRateKHR*     pFragmentShadingRates);

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 VkPhysicalDevice 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 VkPhysicalDeviceFragmentShadingRateKHR structures

Return Codes

On success, this command returns

• SUCCESS
• INCOMPLETE

On failure, this command returns

• ERROR_OUT_OF_HOST_MEMORY

See Also

VkPhysicalDeviceFragmentShadingRateKHR

Parameters:

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

pFragmentShadingRateCount - a pointer to an integer related to the number of fragment shading rates available or queried, as described below.

pFragmentShadingRates - either NULL or a pointer to an array of VkPhysicalDeviceFragmentShadingRateKHR structures.

nvkCmdSetFragmentShadingRateKHR

public static void nvkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 long pFragmentSize,
 long combinerOps)

Unsafe version of: CmdSetFragmentShadingRateKHR

vkCmdSetFragmentShadingRateKHR

public static void vkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkExtent2D pFragmentSize,
 IntBuffer combinerOps)

Set pipeline fragment shading rate and combiner operation dynamically for a command buffer.

C Specification

To dynamically set the pipeline fragment shading rate and combiner operation, call:

 void vkCmdSetFragmentShadingRateKHR(
     VkCommandBuffer                             commandBuffer,
     const VkExtent2D*                           pFragmentSize,
     const VkFragmentShadingRateCombinerOpKHR    combinerOps[2]);

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 VkPipelineDynamicStateCreateInfo::pDynamicStates. Otherwise, this state is specified by the VkPipelineFragmentShadingRateStateCreateInfoKHR values used to create the currently active pipeline.

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 VkCommandBuffer handle
• pFragmentSize must be a valid pointer to a valid VkExtent2D structure
• Each element of combinerOps must be a valid VkFragmentShadingRateCombinerOpKHR value
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics 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 VkCommandPool 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	Graphics	State

See Also

VkExtent2D

Parameters:

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

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

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

vkGetPhysicalDeviceFragmentShadingRatesKHR

public static int vkGetPhysicalDeviceFragmentShadingRatesKHR(org.lwjgl.vulkan.VkPhysicalDevice physicalDevice,
 int[] pFragmentShadingRateCount,
 @Nullable
 VkPhysicalDeviceFragmentShadingRateKHR.Buffer pFragmentShadingRates)

Array version of: GetPhysicalDeviceFragmentShadingRatesKHR

vkCmdSetFragmentShadingRateKHR

public static void vkCmdSetFragmentShadingRateKHR(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 VkExtent2D pFragmentSize,
 int[] combinerOps)

Array version of: CmdSetFragmentShadingRateKHR