vkCmdBindShadingRateImageNV(3)

# vkCmdBindShadingRateImageNV(3) Manual Page

## Name

vkCmdBindShadingRateImageNV - Bind a shading rate image on a command buffer

Loading... please wait.

## C Specification

When shading rate image usage is enabled in the bound pipeline, the pipeline uses a shading rate image specified by the command:

    void vkCmdBindShadingRateImageNV(
        VkCommandBuffer                             commandBuffer,
        VkImageView                                 imageView,
        VkImageLayout                               imageLayout);

## 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 VK_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.

## Description

Valid Usage

- The shading rate image feature must be enabled

- If `imageView` is not VK_NULL_HANDLE, it must be a valid VkImageView handle of type `VK_IMAGE_VIEW_TYPE_2D` or `VK_IMAGE_VIEW_TYPE_2D_ARRAY`

- If `imageView` is not VK_NULL_HANDLE, it must have a format of `VK_FORMAT_R8_UINT`

- If `imageView` is not VK_NULL_HANDLE, it must have been created with a `usage` value including `VK_IMAGE_USAGE_SHADING_RATE_IMAGE_BIT_NV`

- If `imageView` is not VK_NULL_HANDLE, `imageLayout` must match the actual VkImageLayout of each subresource accessible from `imageView` at the time the subresource is accessed

- If `imageView` is not VK_NULL_HANDLE, `imageLayout` must be `VK_IMAGE_LAYOUT_SHADING_RATE_OPTIMAL_NV` or `VK_IMAGE_LAYOUT_GENERAL`

Valid Usage (Implicit)

- `commandBuffer` must be a valid VkCommandBuffer handle

- If `imageView` is not VK_NULL_HANDLE, `imageView` must be a valid VkImageView handle

- `imageLayout` must be a valid VkImageLayout value

- `commandBuffer` must be in the recording state

- The `VkCommandPool` 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 VkDevice

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 | Pipeline Type
--- | --- | --- | ---
Primary Secondary | Both | Graphics |

## See Also

VkCommandBuffer, VkImageLayout, VkImageView

## Document Notes

For more information, see the Vulkan Specification

This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.

## Copyright

Copyright (c) 2014-2020 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.