vkCmdPipelineStatisticSetEXT

VkCmdPipelineStatistics is a function from the Vulkan API that retrieves pipeline statistics after a pipeline has been recorded.

The function vkCmdPipelineStatistics is used to determine the different statistics that can be collected from a pipeline. The pipeline being referenced is one that has already been recorded, and thus any statistics at this point will be that which was produced during the execution of the recorded pipeline.

The function tokenizes the different statistics available, each identified by a key in the VkPipelineStatisticsFlagBits enumeration. As of 2022, the following types of pipeline statistics can be collected through this function: set of pipeline statistics tokens, storage buffer diffuse colors, coverage colors, and so forth.

When recording a pipeline, the commands themselves do not collect statistics. However, by adding a VkCmdPipelineSStatistics structure to the pipeline after it is recorded and before it is executed, users are able to collect desired pipeline statistics, detailed in a similarly named structure.