VkImageViewSampleWeightCreateInfoQCOM(3)

# VkImageViewSampleWeightCreateInfoQCOM(3) Manual Page

## Name

VkImageViewSampleWeightCreateInfoQCOM - Structure describing weight sampling parameters for image view

Loading… please wait.

## C Specification

If the `pNext` chain includes a `VkImageViewSampleWeightCreateInfoQCOM` structure, then that structure includes a parameter specifying the parameters for weight image views used in weight image sampling.

The `VkImageViewSampleWeightCreateInfoQCOM` structure is defined as:

    // Provided by VK_QCOM_image_processing
    typedef struct VkImageViewSampleWeightCreateInfoQCOM {
        VkStructureType    sType;
        const void*        pNext;
        VkOffset2D         filterCenter;
        VkExtent2D         filterSize;
        uint32_t           numPhases;
    } VkImageViewSampleWeightCreateInfoQCOM;

## Members

- `sType` is a VkStructureType value identifying this structure.

- `pNext` is `NULL` or a pointer to a structure extending this structure.

- `filterCenter` is a VkOffset2D describing the location of the weight filter origin.

- `filterSize` is a VkExtent2D specifying weight filter dimensions.

- `numPhases` is number of sub-pixel filter phases.

## Description

The `filterCenter` specifies the origin or center of the filter kernel, as described in Weight Sampling Operation. The `numPhases` describes the number of sub-pixel filter phases as described in Weight Sampling Phases.

Valid Usage

- VUID-VkImageViewSampleWeightCreateInfoQCOM-filterSize-06958
  `filterSize.width` must be less than or equal to `VkPhysicalDeviceImageProcessingPropertiesQCOM`::`maxWeightFilterDimension.width`

- VUID-VkImageViewSampleWeightCreateInfoQCOM-filterSize-06959
  `filterSize.height` must be less than or equal to `VkPhysicalDeviceImageProcessingPropertiesQCOM`::`maxWeightFilterDimension.height`

- VUID-VkImageViewSampleWeightCreateInfoQCOM-filterCenter-06960
  `filterCenter.x` must be less than or equal to (filterSize.width - 1)

- VUID-VkImageViewSampleWeightCreateInfoQCOM-filterCenter-06961
  `filterCenter.y` must be less than or equal to (filterSize.height - 1)

- VUID-VkImageViewSampleWeightCreateInfoQCOM-numPhases-06962
  `numPhases` must be a power of two squared value (i.e., 1, 4, 16, 64, 256, etc.)

- VUID-VkImageViewSampleWeightCreateInfoQCOM-numPhases-06963
  `numPhases` must be less than or equal to `VkPhysicalDeviceImageProcessingPropertiesQCOM`::`maxWeightFilterPhases`

Valid Usage (Implicit)

- VUID-VkImageViewSampleWeightCreateInfoQCOM-sType-sType
  `sType` must be `VK_STRUCTURE_TYPE_IMAGE_VIEW_SAMPLE_WEIGHT_CREATE_INFO_QCOM`

## See Also

VK_QCOM_image_processing, VkExtent2D, VkOffset2D, VkStructureType

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

SPDX-License-Identifier: CC-BY-4.0