Vulkan.Extensions.VK_QCOM_tile_properties

Name

VK_QCOM_tile_properties - device extension

VK_QCOM_tile_properties

Name String

VK_QCOM_tile_properties

Extension Type

Device extension

Registered Extension Number

485

Revision

1

Extension and Version Dependencies

• Requires support for Vulkan 1.0
• Requires VK_KHR_get_physical_device_properties2 to be enabled for any device-level functionality

Contact

• Jeff Leger @jackohound%0A*Here describe the issue or question you have about the VK_QCOM_tile_properties extension*

Extension Proposal

VK_QCOM_tile_properties

Other Extension Metadata

Last Modified Date

2022-07-11

Interactions and External Dependencies

• This extension interacts with VK_EXT_subpass_merge_feedback

Contributors

• Jonathan Wicks, Qualcomm Technologies, Inc.
• Jonathan Tinkham, Qualcomm Technologies, Inc.
• Arpit Agarwal, Qualcomm Technologies, Inc.
• Jeff Leger, Qualcomm Technologies, Inc.

Description

This extension allows an application to query the tile properties. This extension supports both renderpasses and dynamic rendering.

New Commands

• getDynamicRenderingTilePropertiesQCOM

• getFramebufferTilePropertiesQCOM

New Structures

• RenderingInfoKHR

• TilePropertiesQCOM

• Extending PhysicalDeviceFeatures2, DeviceCreateInfo:

  • PhysicalDeviceTilePropertiesFeaturesQCOM

New Enum Constants

• QCOM_TILE_PROPERTIES_EXTENSION_NAME

• QCOM_TILE_PROPERTIES_SPEC_VERSION

• Extending StructureType:

  • STRUCTURE_TYPE_PHYSICAL_DEVICE_TILE_PROPERTIES_FEATURES_QCOM
  • STRUCTURE_TYPE_TILE_PROPERTIES_QCOM

Version History

• Revision 1, 2022-07-11 (Arpit Agarwal)

  • Initial version

See Also

PhysicalDeviceTilePropertiesFeaturesQCOM, RenderingInfoKHR, TilePropertiesQCOM, getDynamicRenderingTilePropertiesQCOM, getFramebufferTilePropertiesQCOM

Document Notes

For more information, see the Vulkan Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

getFramebufferTilePropertiesQCOM

Arguments

:: forall io. MonadIO io

=> Device

device is a logical device associated with the framebuffer.

-> Framebuffer

framebuffer is a handle of the framebuffer to query.

-> io (Result, "properties" ::: Vector TilePropertiesQCOM)

vkGetFramebufferTilePropertiesQCOM - Get tile properties from the attachments in framebuffer

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 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 RenderPassSubpassFeedbackInfoEXT.

Valid Usage (Implicit)

• device must be a valid Device handle

• framebuffer must be a valid Framebuffer 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 TilePropertiesQCOM structures
• framebuffer must have been created, allocated, or retrieved from device

Return Codes

Success

• SUCCESS
• INCOMPLETE

See Also

VK_QCOM_tile_properties, Device, Framebuffer, TilePropertiesQCOM

getDynamicRenderingTilePropertiesQCOM

Arguments

:: forall a io. (Extendss RenderingInfo a, PokeChain a, MonadIO io)

=> Device

device is a logical device associated with the render pass.

device must be a valid Device handle

-> RenderingInfo a

pRenderingInfo is a pointer to the RenderingInfo structure specifying details of the render pass instance in dynamic rendering.

pRenderingInfo must be a valid pointer to a valid RenderingInfo structure

-> io TilePropertiesQCOM

vkGetDynamicRenderingTilePropertiesQCOM - Get the properties when using dynamic rendering

Return Codes

Success

• SUCCESS

See Also

VK_QCOM_tile_properties, Device, RenderingInfo, TilePropertiesQCOM

data PhysicalDeviceTilePropertiesFeaturesQCOM

VkPhysicalDeviceTilePropertiesFeaturesQCOM - Structure describing tile properties features that can be supported by an implementation

Members

This structure describes the following features:

Description

If the PhysicalDeviceTilePropertiesFeaturesQCOM structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDeviceTilePropertiesFeaturesQCOM can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_QCOM_tile_properties, Bool32, StructureType

Constructors

PhysicalDeviceTilePropertiesFeaturesQCOM

Fields

• tileProperties :: Bool

  tileProperties indicates that the implementation supports queries for returning tile properties.

Instances

Storable PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

sizeOf :: PhysicalDeviceTilePropertiesFeaturesQCOM -> Int

alignment :: PhysicalDeviceTilePropertiesFeaturesQCOM -> Int

peekElemOff :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> Int -> IO PhysicalDeviceTilePropertiesFeaturesQCOM

pokeElemOff :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> Int -> PhysicalDeviceTilePropertiesFeaturesQCOM -> IO ()

peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceTilePropertiesFeaturesQCOM

pokeByteOff :: Ptr b -> Int -> PhysicalDeviceTilePropertiesFeaturesQCOM -> IO ()

peek :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO PhysicalDeviceTilePropertiesFeaturesQCOM

poke :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> IO ()

Show PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

showsPrec :: Int -> PhysicalDeviceTilePropertiesFeaturesQCOM -> ShowS

show :: PhysicalDeviceTilePropertiesFeaturesQCOM -> String

showList :: [PhysicalDeviceTilePropertiesFeaturesQCOM] -> ShowS

Eq PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

(==) :: PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> Bool

(/=) :: PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> Bool

FromCStruct PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

peekCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO PhysicalDeviceTilePropertiesFeaturesQCOM

ToCStruct PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

withCStruct :: PhysicalDeviceTilePropertiesFeaturesQCOM -> (Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b) -> IO b

pokeCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b -> IO b

withZeroCStruct :: (Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b) -> IO b

pokeZeroCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero PhysicalDeviceTilePropertiesFeaturesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

zero :: PhysicalDeviceTilePropertiesFeaturesQCOM

data TilePropertiesQCOM

VkTilePropertiesQCOM - Structure holding available tile properties

Description

All tiles will be tightly packed around the first tile, with edges being multiples of tile width and/or height from the origin.

Note

Reported value for apronSize will be zero and its functionality will be described in a future extension.

Valid Usage (Implicit)

See Also

VK_QCOM_tile_properties, Extent2D, Extent3D, Offset2D, StructureType, getDynamicRenderingTilePropertiesQCOM, getFramebufferTilePropertiesQCOM

Constructors

TilePropertiesQCOM

Fields

• tileSize :: Extent3D

  tileSize is the dimensions of a tile, with width and height describing the width and height of a tile in pixels, and depth corresponding to the number of slices the tile spans.

• apronSize :: Extent2D

  apronSize is the dimension of the apron.

• origin :: Offset2D

  origin is the top-left corner of the first tile in attachment space.

Instances

Storable TilePropertiesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

sizeOf :: TilePropertiesQCOM -> Int

alignment :: TilePropertiesQCOM -> Int

peekElemOff :: Ptr TilePropertiesQCOM -> Int -> IO TilePropertiesQCOM

pokeElemOff :: Ptr TilePropertiesQCOM -> Int -> TilePropertiesQCOM -> IO ()

peekByteOff :: Ptr b -> Int -> IO TilePropertiesQCOM

pokeByteOff :: Ptr b -> Int -> TilePropertiesQCOM -> IO ()

peek :: Ptr TilePropertiesQCOM -> IO TilePropertiesQCOM

poke :: Ptr TilePropertiesQCOM -> TilePropertiesQCOM -> IO ()

Show TilePropertiesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

showsPrec :: Int -> TilePropertiesQCOM -> ShowS

show :: TilePropertiesQCOM -> String

showList :: [TilePropertiesQCOM] -> ShowS

FromCStruct TilePropertiesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

peekCStruct :: Ptr TilePropertiesQCOM -> IO TilePropertiesQCOM

ToCStruct TilePropertiesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

withCStruct :: TilePropertiesQCOM -> (Ptr TilePropertiesQCOM -> IO b) -> IO b

pokeCStruct :: Ptr TilePropertiesQCOM -> TilePropertiesQCOM -> IO b -> IO b

withZeroCStruct :: (Ptr TilePropertiesQCOM -> IO b) -> IO b

pokeZeroCStruct :: Ptr TilePropertiesQCOM -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero TilePropertiesQCOM

Defined in Vulkan.Extensions.VK_QCOM_tile_properties

Methods

zero :: TilePropertiesQCOM

type QCOM_TILE_PROPERTIES_SPEC_VERSION = 1

pattern QCOM_TILE_PROPERTIES_SPEC_VERSION :: forall a. Integral a => a

type QCOM_TILE_PROPERTIES_EXTENSION_NAME = "VK_QCOM_tile_properties"

pattern QCOM_TILE_PROPERTIES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type RenderingInfoKHR = RenderingInfo