VkCoarseSampleLocationNV(3)

# VkCoarseSampleLocationNV(3) Manual Page

## Name

VkCoarseSampleLocationNV - Structure specifying parameters controlling shading rate image usage

Loading… please wait.

## C Specification

The `VkCoarseSampleLocationNV` structure identifies a specific pixel and sample index for one of the coverage samples in a fragment that is larger than one pixel. This structure is defined as:

    // Provided by VK_NV_shading_rate_image
    typedef struct VkCoarseSampleLocationNV {
        uint32_t    pixelX;
        uint32_t    pixelY;
        uint32_t    sample;
    } VkCoarseSampleLocationNV;

## Members

- `pixelX` is added to the x coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

- `pixelY` is added to the y coordinate of the upper-leftmost pixel of each fragment to identify the pixel containing the coverage sample.

- `sample` is the number of the coverage sample in the pixel identified by `pixelX` and `pixelY`.

## Description

Valid Usage

- VUID-VkCoarseSampleLocationNV-pixelX-02078
  `pixelX` must be less than the width (in pixels) of the fragment

- VUID-VkCoarseSampleLocationNV-pixelY-02079
  `pixelY` must be less than the height (in pixels) of the fragment

- VUID-VkCoarseSampleLocationNV-sample-02080
  `sample` must be less than the number of coverage samples in each pixel belonging to the fragment

## See Also

VK_NV_shading_rate_image, VkCoarseSampleOrderCustomNV

## 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 2014-2022 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0