Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_QCOM_tile_properties

Description

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

Ratification Status

Not ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2 or Vulkan Version 1.1

API Interactions

Interacts with VK_VERSION_1_3
Interacts with VK_KHR_dynamic_rendering

Contact

Matthew Netsch @mnetsch%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

TilePropertiesQCOM

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceTilePropertiesFeaturesQCOM

If VK_KHR_dynamic_rendering or Vulkan Version 1.3 is supported:

RenderingInfoKHR

New Enum Constants

QCOM_TILE_PROPERTIES_EXTENSION_NAME

Version History

Revision 1, 2022-07-11 (Arpit Agarwal)
- Initial version

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.

Synopsis

getFramebufferTilePropertiesQCOM :: MonadIO io => Device -> Framebuffer -> io (Result, "properties" ::: Vector TilePropertiesQCOM)
getDynamicRenderingTilePropertiesQCOM :: forall (a :: [Type]) io. (Extendss RenderingInfo a, PokeChain a, MonadIO io) => Device -> RenderingInfo a -> io TilePropertiesQCOM
data PhysicalDeviceTilePropertiesFeaturesQCOM = PhysicalDeviceTilePropertiesFeaturesQCOM {
- tileProperties :: Bool
}
data TilePropertiesQCOM = TilePropertiesQCOM {
- tileSize :: Extent3D
- apronSize :: Extent2D
- origin :: Offset2D
}
type QCOM_TILE_PROPERTIES_SPEC_VERSION = 1
pattern QCOM_TILE_PROPERTIES_SPEC_VERSION :: Integral a => a
type QCOM_TILE_PROPERTIES_EXTENSION_NAME = "VK_QCOM_tile_properties"
pattern QCOM_TILE_PROPERTIES_EXTENSION_NAME :: (Eq a, IsString a) => a
type RenderingInfoKHR = RenderingInfo

Documentation

getFramebufferTilePropertiesQCOM Source #

Arguments

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

INCOMPLETE
SUCCESS

Failure

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. If the application wishes to use a Device with any features described by PhysicalDeviceTilePropertiesFeaturesQCOM, it must add an instance of the structure, with the desired feature members set to TRUE, to the pNext chain of DeviceCreateInfo when creating the Device.

Valid Usage (Implicit)

Eq PhysicalDeviceTilePropertiesFeaturesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods (==) :: PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> Bool # (/=) :: PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> Bool #
Storable PhysicalDeviceTilePropertiesFeaturesQCOM Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods showsPrec :: Int -> PhysicalDeviceTilePropertiesFeaturesQCOM -> ShowS # show :: PhysicalDeviceTilePropertiesFeaturesQCOM -> String # showList :: [PhysicalDeviceTilePropertiesFeaturesQCOM] -> ShowS #
FromCStruct PhysicalDeviceTilePropertiesFeaturesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods peekCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO PhysicalDeviceTilePropertiesFeaturesQCOM Source #
ToCStruct PhysicalDeviceTilePropertiesFeaturesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods withCStruct :: PhysicalDeviceTilePropertiesFeaturesQCOM -> (Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceTilePropertiesFeaturesQCOM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceTilePropertiesFeaturesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods zero :: PhysicalDeviceTilePropertiesFeaturesQCOM Source #

data TilePropertiesQCOM Source #

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.

The tileSize is guaranteed to be a multiple of tileGranularity.

Valid Usage (Implicit)

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

Instances details

Storable TilePropertiesQCOM Source #
Instance details 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 Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods showsPrec :: Int -> TilePropertiesQCOM -> ShowS # show :: TilePropertiesQCOM -> String # showList :: [TilePropertiesQCOM] -> ShowS #
FromCStruct TilePropertiesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods peekCStruct :: Ptr TilePropertiesQCOM -> IO TilePropertiesQCOM Source #
ToCStruct TilePropertiesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods withCStruct :: TilePropertiesQCOM -> (Ptr TilePropertiesQCOM -> IO b) -> IO b Source # pokeCStruct :: Ptr TilePropertiesQCOM -> TilePropertiesQCOM -> IO b -> IO b Source # withZeroCStruct :: (Ptr TilePropertiesQCOM -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr TilePropertiesQCOM -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero TilePropertiesQCOM Source #
Instance details Defined in Vulkan.Extensions.VK_QCOM_tile_properties Methods zero :: TilePropertiesQCOM Source #

type QCOM_TILE_PROPERTIES_SPEC_VERSION = 1 Source #

pattern QCOM_TILE_PROPERTIES_SPEC_VERSION :: Integral a => a Source #

type QCOM_TILE_PROPERTIES_EXTENSION_NAME = "VK_QCOM_tile_properties" Source #

pattern QCOM_TILE_PROPERTIES_EXTENSION_NAME :: (Eq a, IsString a) => a Source #

type RenderingInfoKHR = RenderingInfo Source #

Name

VK_QCOM_tile_properties

Other Extension Metadata

Description

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Description

Valid Usage (Implicit)

Return Codes

See Also

Return Codes

See Also

Members

Description

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

:: forall (a :: [Type]) 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

PhysicalDeviceTilePropertiesFeaturesQCOM
Fields tileProperties :: Bool `tileProperties` indicates that the implementation supports queries for returning tile properties.