Package org.lwjgl.vulkan

Class NVFragmentShadingRateEnums

java.lang.Object

org.lwjgl.vulkan.NVFragmentShadingRateEnums

public class NVFragmentShadingRateEnums
extends java.lang.Object

This extension builds on the fragment shading rate functionality provided by the VK_KHR_fragment_shading_rate extension, adding support for “supersample” fragment shading rates that trigger multiple fragment shader invocations per pixel as well as a “no invocations” shading rate that discards any portions of a primitive that would use that shading rate.

VK_NV_fragment_shading_rate_enums

Name String

VK_NV_fragment_shading_rate_enums

Extension Type

Device extension

Registered Extension Number

327

Revision

1

Extension and Version Dependencies

• Requires Vulkan 1.0
• Requires VK_KHR_fragment_shading_rate

Contact

• Pat Brown nvpbrown

Other Extension Metadata

Last Modified Date

2020-09-02

Contributors

• Pat Brown, NVIDIA
• Jeff Bolz, NVIDIA

Field Summary

Fields

Modifier and Type	Field	Description
static int	VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_1X2_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X1_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X2_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X4_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X2_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X4_PIXELS_NV VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_PIXEL_NV VK_FRAGMENT_SHADING_RATE_16_INVOCATIONS_PER_PIXEL_NV VK_FRAGMENT_SHADING_RATE_2_INVOCATIONS_PER_PIXEL_NV VK_FRAGMENT_SHADING_RATE_4_INVOCATIONS_PER_PIXEL_NV VK_FRAGMENT_SHADING_RATE_8_INVOCATIONS_PER_PIXEL_NV VK_FRAGMENT_SHADING_RATE_NO_INVOCATIONS_NV	VkFragmentShadingRateNV - Enumeration with fragment shading rates
static int	VK_FRAGMENT_SHADING_RATE_TYPE_ENUMS_NV VK_FRAGMENT_SHADING_RATE_TYPE_FRAGMENT_SIZE_NV	VkFragmentShadingRateTypeNV - Enumeration with fragment shading rate types
static java.lang.String	VK_NV_FRAGMENT_SHADING_RATE_ENUMS_EXTENSION_NAME	The extension name.
static int	VK_NV_FRAGMENT_SHADING_RATE_ENUMS_SPEC_VERSION	The extension specification version.
static int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_FEATURES_NV VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_PROPERTIES_NV VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_ENUM_STATE_CREATE_INFO_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static void	nvkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int shadingRate, long combinerOps)	Unsafe version of: CmdSetFragmentShadingRateEnumNV
static void	vkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int shadingRate, int[] combinerOps)	Array version of: CmdSetFragmentShadingRateEnumNV
static void	vkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int shadingRate, java.nio.IntBuffer combinerOps)	Set pipeline fragment shading rate dynamically for a command buffer using enums.

Methods inherited from class java.lang.Object

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

Field Detail

VK_NV_FRAGMENT_SHADING_RATE_ENUMS_SPEC_VERSION

The extension specification version.

VK_NV_FRAGMENT_SHADING_RATE_ENUMS_EXTENSION_NAME

The extension name.

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_PROPERTIES_NV, VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_FEATURES_NV, VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_ENUM_STATE_CREATE_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_PROPERTIES_NV
• STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_ENUMS_FEATURES_NV
• STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_ENUM_STATE_CREATE_INFO_NV

VK_FRAGMENT_SHADING_RATE_TYPE_FRAGMENT_SIZE_NV, VK_FRAGMENT_SHADING_RATE_TYPE_ENUMS_NV

VkFragmentShadingRateTypeNV - Enumeration with fragment shading rate types

Description

• FRAGMENT_SHADING_RATE_TYPE_FRAGMENT_SIZE_NV specifies that a graphics pipeline should obtain its pipeline fragment shading rate and shading rate combiner state from the VkPipelineFragmentShadingRateStateCreateInfoKHR structure and that any state specified by the VkPipelineFragmentShadingRateEnumStateCreateInfoNV structure should be ignored.
• FRAGMENT_SHADING_RATE_TYPE_ENUMS_NV specifies that a graphics pipeline should obtain its pipeline fragment shading rate and shading rate combiner state from the VkPipelineFragmentShadingRateEnumStateCreateInfoNV structure and that any state specified by the VkPipelineFragmentShadingRateStateCreateInfoKHR structure should be ignored.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV

VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_PIXEL_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_1X2_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X1_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X2_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X4_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X2_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X4_PIXELS_NV, VK_FRAGMENT_SHADING_RATE_2_INVOCATIONS_PER_PIXEL_NV, VK_FRAGMENT_SHADING_RATE_4_INVOCATIONS_PER_PIXEL_NV, VK_FRAGMENT_SHADING_RATE_8_INVOCATIONS_PER_PIXEL_NV, VK_FRAGMENT_SHADING_RATE_16_INVOCATIONS_PER_PIXEL_NV, VK_FRAGMENT_SHADING_RATE_NO_INVOCATIONS_NV

VkFragmentShadingRateNV - Enumeration with fragment shading rates

Description

• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_PIXEL_NV specifies a fragment size of 1x1 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_1X2_PIXELS_NV specifies a fragment size of 1x2 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X1_PIXELS_NV specifies a fragment size of 2x1 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X2_PIXELS_NV specifies a fragment size of 2x2 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_2X4_PIXELS_NV specifies a fragment size of 2x4 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X2_PIXELS_NV specifies a fragment size of 4x2 pixels.
• FRAGMENT_SHADING_RATE_1_INVOCATION_PER_4X4_PIXELS_NV specifies a fragment size of 4x4 pixels.
• FRAGMENT_SHADING_RATE_2_INVOCATIONS_PER_PIXEL_NV specifies a fragment size of 1x1 pixels, with two fragment shader invocations per fragment.
• FRAGMENT_SHADING_RATE_4_INVOCATIONS_PER_PIXEL_NV specifies a fragment size of 1x1 pixels, with four fragment shader invocations per fragment.
• FRAGMENT_SHADING_RATE_8_INVOCATIONS_PER_PIXEL_NV specifies a fragment size of 1x1 pixels, with eight fragment shader invocations per fragment.
• FRAGMENT_SHADING_RATE_16_INVOCATIONS_PER_PIXEL_NV specifies a fragment size of 1x1 pixels, with sixteen fragment shader invocations per fragment.
• FRAGMENT_SHADING_RATE_NO_INVOCATIONS_NV specifies that any portions of a primitive that use that shading rate should be discarded without invoking any fragment shader.

To use the shading rates FRAGMENT_SHADING_RATE_2_INVOCATIONS_PER_PIXEL_NV, FRAGMENT_SHADING_RATE_4_INVOCATIONS_PER_PIXEL_NV, FRAGMENT_SHADING_RATE_8_INVOCATIONS_PER_PIXEL_NV, and FRAGMENT_SHADING_RATE_16_INVOCATIONS_PER_PIXEL_NV as a pipeline, primitive, or attachment shading rate, the supersampleFragmentShadingRates feature must be enabled. To use the shading rate FRAGMENT_SHADING_RATE_NO_INVOCATIONS_NV as a pipeline, primitive, or attachment shading rate, the noInvocationFragmentShadingRates feature must be enabled.

See Also

VkPipelineFragmentShadingRateEnumStateCreateInfoNV, CmdSetFragmentShadingRateEnumNV

Method Detail

nvkCmdSetFragmentShadingRateEnumNV

public static void nvkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                      int shadingRate,
                                                      long combinerOps)

Unsafe version of: CmdSetFragmentShadingRateEnumNV

vkCmdSetFragmentShadingRateEnumNV

public static void vkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                     int shadingRate,
                                                     java.nio.IntBuffer combinerOps)

Set pipeline fragment shading rate dynamically for a command buffer using enums.

C Specification

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

 void vkCmdSetFragmentShadingRateEnumNV(
     VkCommandBuffer                             commandBuffer,
     VkFragmentShadingRateNV                     shadingRate,
     const VkFragmentShadingRateCombinerOpKHR    combinerOps[2]);

Description

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

Note

This command allows specifying additional shading rates beyond those supported by CmdSetFragmentShadingRateKHR. For more information, refer to the VK_NV_fragment_shading_rate_enums appendix.

Valid Usage

• If pipelineFragmentShadingRate is not enabled, shadingRate must be FRAGMENT_SHADING_RATE_1_INVOCATION_PER_PIXEL_NV
• If supersampleFragmentShadingRates is not enabled, shadingRate must not be FRAGMENT_SHADING_RATE_2_INVOCATIONS_PER_PIXEL_NV, FRAGMENT_SHADING_RATE_4_INVOCATIONS_PER_PIXEL_NV, FRAGMENT_SHADING_RATE_8_INVOCATIONS_PER_PIXEL_NV, or FRAGMENT_SHADING_RATE_16_INVOCATIONS_PER_PIXEL_NV
• If noInvocationFragmentShadingRates is not enabled, shadingRate must not be FRAGMENT_SHADING_RATE_NO_INVOCATIONS_NV
• fragmentShadingRateEnums must be enabled
• 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

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• shadingRate must be a valid VkFragmentShadingRateNV value
• Any given 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

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	Supported Queue Types
Primary Secondary	Both	Graphics

Parameters:

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

shadingRate - specifies a VkFragmentShadingRateNV enum indicating 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.

vkCmdSetFragmentShadingRateEnumNV

public static void vkCmdSetFragmentShadingRateEnumNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
                                                     int shadingRate,
                                                     int[] combinerOps)

Array version of: CmdSetFragmentShadingRateEnumNV