Function Prototype

vkCmdWriteMicromapsPropertiesEXT

Write micromap result parameters to query results.
primary / secondary
outside
compute
action

To query micromap size parameters call:

void vkCmdWriteMicromapsPropertiesEXT(
    VkCommandBuffer commandBuffer,
    uint32_t micromapCount,
    const VkMicromapEXT* pMicromaps,
    VkQueryType queryType,
    VkQueryPool queryPool,
    uint32_t firstQuery);
  • commandBuffer is the command buffer into which the command will be recorded.
  • micromapCount is the count of micromaps for which to query the property.
  • pMicromaps is a pointer to an array of existing previously built micromaps.
  • queryType is a VkQueryType value specifying the type of queries managed by the pool.
  • queryPool is the query pool that will manage the results of the query.
  • firstQuery is the first query index within the query pool that will contain the micromapCount number of results.

Accesses to any of the micromaps listed in pMicromaps must be synchronized with the VK_PIPELINE_STAGE_2_MICROMAP_BUILD_BIT_EXT

pipeline stage and an access type of VK_ACCESS_2_MICROMAP_READ_BIT_EXT.

  • If queryType is VK_QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT, then the value written out is the number of bytes required by a serialized micromap.
  • If queryType is VK_QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT, then the value written out is the number of bytes required by a compacted micromap.

Valid Usage

VUID-vkCmdWriteMicromapsPropertiesEXT-queryPool-07525

queryPool must have been created with a queryType matching queryType

VUID-vkCmdWriteMicromapsPropertiesEXT-queryPool-07526

The queries identified by queryPool and firstQuery must be unavailable

VUID-vkCmdWriteMicromapsPropertiesEXT-buffer-07527

The buffer used to create each micromap in pMicrmaps must be bound to device memory

VUID-vkCmdWriteMicromapsPropertiesEXT-query-07528

The sum of query plus micromapCount must be less than or equal to the number of queries in queryPool

VUID-vkCmdWriteMicromapsPropertiesEXT-pMicromaps-07501

All micromaps in pMicromaps must have been constructed prior to the execution of this command

VUID-vkCmdWriteMicromapsPropertiesEXT-pMicromaps-07502

All micromaps in pMicromaps must have been constructed with VK_BUILD_MICROMAP_ALLOW_COMPACTION_BIT_EXT if queryType is VK_QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT

VUID-vkCmdWriteMicromapsPropertiesEXT-queryType-07503

queryType must be VK_QUERY_TYPE_MICROMAP_COMPACTED_SIZE_EXT or VK_QUERY_TYPE_MICROMAP_SERIALIZATION_SIZE_EXT

Valid Usage (Implicit)

VUID-vkCmdWriteMicromapsPropertiesEXT-pMicromaps-parameter

pMicromaps must be a valid pointer to an array of micromapCount valid VkMicromapEXT handles

VUID-vkCmdWriteMicromapsPropertiesEXT-commandBuffer-cmdpool

The VkCommandPool that commandBuffer was allocated from must support compute operations

VUID-vkCmdWriteMicromapsPropertiesEXT-renderpass

This command must only be called outside of a render pass instance

VUID-vkCmdWriteMicromapsPropertiesEXT-videocoding

This command must only be called outside of a video coding scope

VUID-vkCmdWriteMicromapsPropertiesEXT-commonparent

Each of commandBuffer, queryPool, and the elements of pMicromaps must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

  • Host access to commandBuffer must be externally synchronized
  • Host access to the VkCommandPool that commandBuffer was allocated from must be externally synchronized ::