vkCmdBindShadingRateImageNV - Bind a shading rate image on a command buffer

Parameters

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

• imageView is an image view handle specifying the shading rate image. imageView may be set to NULL_HANDLE, which is equivalent to specifying a view of an image filled with zero values.
• imageLayout is the layout that the image subresources accessible from imageView will be in when the shading rate image is accessed.

Valid Usage

• The shading rate image feature must be enabled.

• If imageView is not NULL_HANDLE, it must be a valid ImageView handle of type IMAGE_VIEW_TYPE_2D or IMAGE_VIEW_TYPE_2D_ARRAY.
• If imageView is not NULL_HANDLE, it must have a format of FORMAT_R8_UINT.
• If imageView is not NULL_HANDLE, it must have been created with a usage value including IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV
• If imageView is not NULL_HANDLE, imageLayout must match the actual ImageLayout of each subresource accessible from imageView at the time the subresource is accessed.
• If imageView is not NULL_HANDLE, imageLayout must be IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV or IMAGE_LAYOUT_GENERAL.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• If imageView is not NULL_HANDLE, imageView must be a valid ImageView handle
• imageLayout must be a valid ImageLayout value
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• Both of commandBuffer, and imageView that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

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

'

See Also

CommandBuffer, ImageLayout, ImageView

vkCmdSetViewportShadingRatePaletteNV - Set shading rate image palettes on a command buffer

Parameters

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

• firstViewport is the index of the first viewport whose shading rate palette is updated by the command.
• viewportCount is the number of viewports whose shading rate palettes are updated by the command.
• pShadingRatePalettes is a pointer to an array of ShadingRatePaletteNV structures defining the palette for each viewport.

Valid Usage

• The shading rate image feature must be enabled.

• firstViewport must be less than PhysicalDeviceLimits::maxViewports
• The sum of firstViewport and viewportCount must be between 1 and PhysicalDeviceLimits::maxViewports, inclusive
• If the multiple viewports feature is not enabled, firstViewport must be 0
• If the multiple viewports feature is not enabled, viewportCount must be 1

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pShadingRatePalettes must be a valid pointer to an array of viewportCount valid ShadingRatePaletteNV structures
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics operations
• viewportCount must be greater than 0

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

'

See Also

CommandBuffer, ShadingRatePaletteNV

vkCmdSetCoarseSampleOrderNV - Set sample order for coarse fragments on a command buffer

Parameters

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

• sampleOrderType specifies the mechanism used to order coverage samples in fragments larger than one pixel.
• customSampleOrderCount specifies the number of custom sample orderings to use when ordering coverage samples.
• pCustomSampleOrders is a pointer to an array of CoarseSampleOrderCustomNV structures, each of which specifies the coverage sample order for a single combination of fragment area and coverage sample count.

Description

If sampleOrderType is COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated in pCustomSampleOrders will be identical to that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

Valid Usage

• If sampleOrderType is not COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, customSamplerOrderCount must be 0

• The array pCustomSampleOrders must not contain two structures with matching values for both the shadingRate and sampleCount members.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• sampleOrderType must be a valid CoarseSampleOrderTypeNV value
• If customSampleOrderCount is not 0, pCustomSampleOrders must be a valid pointer to an array of customSampleOrderCount valid CoarseSampleOrderCustomNV structures
• 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

'

See Also

CoarseSampleOrderCustomNV, CoarseSampleOrderTypeNV, CommandBuffer

VkShadingRatePaletteNV - Structure specifying a single shading rate palette

Valid Usage (Implicit)

See Also

PipelineViewportShadingRateImageStateCreateInfoNV, ShadingRatePaletteEntryNV, cmdSetViewportShadingRatePaletteNV

VkPipelineViewportShadingRateImageStateCreateInfoNV - Structure specifying parameters controlling shading rate image usage

Description

If this structure is not present, shadingRateImageEnable is considered to be FALSE, and the shading rate image and palettes are not used.

Valid Usage

• If the multiple viewports feature is not enabled, viewportCount must be 0 or 1

• viewportCount must be less than or equal to PhysicalDeviceLimits::maxViewports
• If shadingRateImageEnable is TRUE, viewportCount must be equal to the viewportCount member of PipelineViewportStateCreateInfo
• If no element of the pDynamicStates member of pDynamicState is DYNAMIC_STATE_VIEWPORT_SHADING_RATE_PALETTE_NV, pShadingRatePalettes must be a valid pointer to an array of viewportCount ShadingRatePaletteNV structures

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_SHADING_RATE_IMAGE_STATE_CREATE_INFO_NV

• If viewportCount is not 0, and pShadingRatePalettes is not NULL, pShadingRatePalettes must be a valid pointer to an array of viewportCount valid ShadingRatePaletteNV structures

See Also

Bool32, ShadingRatePaletteNV, StructureType

VkPhysicalDeviceShadingRateImageFeaturesNV - Structure describing shading rate image features that can be supported by an implementation

Members

The members of the PhysicalDeviceShadingRateImageFeaturesNV structure describe the following features:

Description

See Shading Rate Image for more information.

If the PhysicalDeviceShadingRateImageFeaturesNV structure is included in the pNext chain of PhysicalDeviceFeatures2, it is filled with values indicating whether the feature is supported. PhysicalDeviceShadingRateImageFeaturesNV can also be included in the pNext chain of DeviceCreateInfo to enable features.

Valid Usage (Implicit)

See Also

Bool32, StructureType

VkPhysicalDeviceShadingRateImagePropertiesNV - Structure describing shading rate image limits that can be supported by an implementation

Members

The members of the PhysicalDeviceShadingRateImagePropertiesNV structure describe the following implementation-dependent properties related to the shading rate image feature:

Description

If the PhysicalDeviceShadingRateImagePropertiesNV structure is included in the pNext chain of PhysicalDeviceProperties2, it is filled with the implementation-dependent limits.

Valid Usage (Implicit)

See Also

Extent2D, StructureType

VkCoarseSampleLocationNV - Structure specifying parameters controlling shading rate image usage

Valid Usage

See Also

CoarseSampleOrderCustomNV

VkCoarseSampleOrderCustomNV - Structure specifying parameters controlling shading rate image usage

Description

When using a custom sample ordering, element i in pSampleLocations specifies a specific pixel and per-pixel coverage sample number that corresponds to the coverage sample numbered i in the multi-pixel fragment.

Valid Usage

• shadingRate must be a shading rate that generates fragments with more than one pixel.

• sampleCount must correspond to a sample count enumerated in SampleCountFlags whose corresponding bit is set in PhysicalDeviceLimits::framebufferNoAttachmentsSampleCounts.
• sampleLocationCount must be equal to the product of sampleCount, the fragment width for shadingRate, and the fragment height for shadingRate.
• sampleLocationCount must be less than or equal to the value of PhysicalDeviceShadingRateImagePropertiesNV::shadingRateMaxCoarseSamples.
• The array pSampleLocations must contain exactly one entry for every combination of valid values for pixelX, pixelY, and sample in the structure CoarseSampleOrderCustomNV.

Valid Usage (Implicit)

• shadingRate must be a valid ShadingRatePaletteEntryNV value

• pSampleLocations must be a valid pointer to an array of sampleLocationCount CoarseSampleLocationNV structures
• sampleLocationCount must be greater than 0

See Also

CoarseSampleLocationNV, PipelineViewportCoarseSampleOrderStateCreateInfoNV, ShadingRatePaletteEntryNV, cmdSetCoarseSampleOrderNV

VkPipelineViewportCoarseSampleOrderStateCreateInfoNV - Structure specifying parameters controlling sample order in coarse fragments

Description

If this structure is not present, sampleOrderType is considered to be COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If sampleOrderType is COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, the coverage sample order used for any combination of fragment area and coverage sample count not enumerated in pCustomSampleOrders will be identical to that used for COARSE_SAMPLE_ORDER_TYPE_DEFAULT_NV.

If the pipeline was created with DYNAMIC_STATE_VIEWPORT_COARSE_SAMPLE_ORDER_NV, the contents of this structure (if present) are ignored, and the coverage sample order is instead specified by cmdSetCoarseSampleOrderNV.

Valid Usage

• If sampleOrderType is not COARSE_SAMPLE_ORDER_TYPE_CUSTOM_NV, customSamplerOrderCount must be 0

• The array pCustomSampleOrders must not contain two structures with matching values for both the shadingRate and sampleCount members.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_VIEWPORT_COARSE_SAMPLE_ORDER_STATE_CREATE_INFO_NV

• sampleOrderType must be a valid CoarseSampleOrderTypeNV value
• If customSampleOrderCount is not 0, pCustomSampleOrders must be a valid pointer to an array of customSampleOrderCount valid CoarseSampleOrderCustomNV structures

See Also

CoarseSampleOrderCustomNV, CoarseSampleOrderTypeNV, StructureType

VkShadingRatePaletteEntryNV - Shading rate image palette entry types

Description

The following table indicates the width and height (in pixels) of each fragment generated using the indicated shading rate, as well as the maximum number of fragment shader invocations launched for each fragment. When processing regions of a primitive that have a shading rate of SHADING_RATE_PALETTE_ENTRY_NO_INVOCATIONS_NV, no fragments will be generated in that region.

See Also

CoarseSampleOrderCustomNV, ShadingRatePaletteNV

VkCoarseSampleOrderTypeNV - Shading rate image sample ordering types

See Also

PipelineViewportCoarseSampleOrderStateCreateInfoNV, cmdSetCoarseSampleOrderNV