vkGetFramebufferTilePropertiesQCOM(3)

# vkGetFramebufferTilePropertiesQCOM(3) Manual Page

## Name

vkGetFramebufferTilePropertiesQCOM - Get tile properties from the attachments in framebuffer

Loading… please wait.

## C Specification

To query the tile properties from the attachments in framebuffer, call:

    // Provided by VK_QCOM_tile_properties
    VkResult vkGetFramebufferTilePropertiesQCOM(
        VkDevice                                    device,
        VkFramebuffer                               framebuffer,
        uint32_t*                                   pPropertiesCount,
        VkTilePropertiesQCOM*                       pProperties);

## Parameters

- `device` is a logical device associated with the framebuffer.

- `framebuffer` is a handle of the framebuffer to query.

- `pPropertiesCount` is a pointer to an integer related to the number of tile properties available or queried, as described below.

- `pProperties` is either `NULL` or a pointer to an array of VkTilePropertiesQCOM structures.

## Description

If `pProperties` is `NULL`, then the number of tile properties available is returned in `pPropertiesCount`. Otherwise, `pPropertiesCount` must point to a variable set by the user to the number of elements in the `pProperties` array, and on return the variable is overwritten with the number of properties actually written to `pProperties`. If `pPropertiesCount` is less than the number of tile properties available, at most `pPropertiesCount` structures will be written, and `VK_INCOMPLETE` will be returned instead of `VK_SUCCESS`, to indicate that not all the available properties were returned.

The number of tile properties available is determined by the number of merged subpasses, and each tile property is associated with a merged subpass. There will be at most as many properties as there are subpasses within the render pass. To obtain the tile properties for a given merged subpass, the `pProperties` array can be indexed using the `postMergeIndex` value provided in VkRenderPassSubpassFeedbackInfoEXT.

Valid Usage (Implicit)

- VUID-vkGetFramebufferTilePropertiesQCOM-device-parameter
  `device` must be a valid VkDevice handle

- VUID-vkGetFramebufferTilePropertiesQCOM-framebuffer-parameter
  `framebuffer` must be a valid VkFramebuffer handle

- VUID-vkGetFramebufferTilePropertiesQCOM-pPropertiesCount-parameter
  `pPropertiesCount` must be a valid pointer to a `uint32_t` value

- VUID-vkGetFramebufferTilePropertiesQCOM-pProperties-parameter
  If the value referenced by `pPropertiesCount` is not `0`, and `pProperties` is not `NULL`, `pProperties` must be a valid pointer to an array of `pPropertiesCount` VkTilePropertiesQCOM structures

- VUID-vkGetFramebufferTilePropertiesQCOM-framebuffer-parent
  `framebuffer` must have been created, allocated, or retrieved from `device`

Return Codes

On success, this command returns

  - `VK_SUCCESS`

  - `VK_INCOMPLETE`

## See Also

VK_QCOM_tile_properties, VkDevice, VkFramebuffer, VkTilePropertiesQCOM

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