Package org.lwjgl.vulkan

Class QCOMTileProperties

java.lang.Object
org.lwjgl.vulkan.QCOMTileProperties
public class QCOMTileProperties extends Object
This extension allows an application to query the tile properties. This extension supports both renderpasses and dynamic rendering.
Name String
VK_QCOM_tile_properties
Extension Type
Device extension
Registered Extension Number
485
Revision
1
Extension and Version Dependencies
VK_KHR_get_physical_device_properties2 or Version 1.1
API Interactions
  • Interacts with VK_VERSION_1_3
  • Interacts with VK_KHR_dynamic_rendering
Contact
Extension Proposal
VK_QCOM_tile_properties
Other Extension Metadata
Last Modified Date
2022-07-11
Interactions and External Dependencies
Contributors
  • Jonathan Wicks, Qualcomm Technologies, Inc.
  • Jonathan Tinkham, Qualcomm Technologies, Inc.
  • Arpit Agarwal, Qualcomm Technologies, Inc.
  • Jeff Leger, Qualcomm Technologies, Inc.

  • Field Details

  • Method Details

    • nvkGetFramebufferTilePropertiesQCOM

      public static int nvkGetFramebufferTilePropertiesQCOM(org.lwjgl.vulkan.VkDevice device, long framebuffer, long pPropertiesCount, long pProperties)
      Unsafe version of: GetFramebufferTilePropertiesQCOM
      Parameters:
      pPropertiesCount - a pointer to an integer related to the number of tile properties available or queried, as described below.

    • vkGetFramebufferTilePropertiesQCOM

      public static int vkGetFramebufferTilePropertiesQCOM(org.lwjgl.vulkan.VkDevice device, long framebuffer, IntBuffer pPropertiesCount, @Nullable VkTilePropertiesQCOM.Buffer pProperties)
      Get tile properties from the attachments in framebuffer.
      C Specification

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

      
 VkResult vkGetFramebufferTilePropertiesQCOM(
     VkDevice                                    device,
     VkFramebuffer                               framebuffer,
     uint32_t*                                   pPropertiesCount,
     VkTilePropertiesQCOM*                       pProperties);
      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 application 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 INCOMPLETE will be returned instead of 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)
      • device must be a valid VkDevice handle
      • framebuffer must be a valid VkFramebuffer handle
      • pPropertiesCount must be a valid pointer to a uint32_t value
      • 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
      • framebuffer must have been created, allocated, or retrieved from device
      Return Codes
      On success, this command returns
      See Also

      VkTilePropertiesQCOM

      Parameters:
      device - a logical device associated with the framebuffer.
      framebuffer - a handle of the framebuffer to query.
      pPropertiesCount - a pointer to an integer related to the number of tile properties available or queried, as described below.
      pProperties - either NULL or a pointer to an array of VkTilePropertiesQCOM structures.

    • nvkGetDynamicRenderingTilePropertiesQCOM

      public static int nvkGetDynamicRenderingTilePropertiesQCOM(org.lwjgl.vulkan.VkDevice device, long pRenderingInfo, long pProperties)
      Unsafe version of: GetDynamicRenderingTilePropertiesQCOM

    • vkGetDynamicRenderingTilePropertiesQCOM

      public static int vkGetDynamicRenderingTilePropertiesQCOM(org.lwjgl.vulkan.VkDevice device, VkRenderingInfo pRenderingInfo, VkTilePropertiesQCOM pProperties)
      Get the properties when using dynamic rendering.
      C Specification

      To query the tile properties when using dynamic rendering, call:

      
 VkResult vkGetDynamicRenderingTilePropertiesQCOM(
     VkDevice                                    device,
     const VkRenderingInfo*                      pRenderingInfo,
     VkTilePropertiesQCOM*                       pProperties);
      Valid Usage (Implicit)
      • device must be a valid VkDevice handle
      • pRenderingInfo must be a valid pointer to a valid VkRenderingInfo structure
      • pProperties must be a valid pointer to a VkTilePropertiesQCOM structure
      Return Codes
      On success, this command returns
      See Also

      VkRenderingInfo, VkTilePropertiesQCOM

      Parameters:
      device - a logical device associated with the render pass.
      pRenderingInfo - a pointer to the VkRenderingInfo structure specifying details of the render pass instance in dynamic rendering.
      pProperties - a pointer to a VkTilePropertiesQCOM structure in which the properties are returned.

    • vkGetFramebufferTilePropertiesQCOM

      public static int vkGetFramebufferTilePropertiesQCOM(org.lwjgl.vulkan.VkDevice device, long framebuffer, int[] pPropertiesCount, @Nullable VkTilePropertiesQCOM.Buffer pProperties)
      Array version of: GetFramebufferTilePropertiesQCOM