VkPresentId2KHR

The VkPresentId2KHR structure is defined as:

typedef struct VkPresentId2KHR {
    VkStructureType sType;
    const void* pNext;
    uint32_t swapchainCount;
    const uint64_t* pPresentIds;
} VkPresentId2KHR;

pub struct PresentId2KHR {
    s_type: vk::StructureType,
    p_next: *const c_void,
    swapchain_count: u32, // Copy of VkPresentInfoKHR::swapchainCount
    p_present_ids: *const u64, // Present ID values for each swapchain
}

• sType is a VkStructureType value identifying this structure.
• pNext is NULL or a pointer to a structure extending this structure.
• swapchainCount is the number of swapchains being presented to the vkQueuePresentKHR command.
• pPresentIds is NULL or a pointer to an array of uint64_t with swapchainCount entries. If not NULL, each non-zero value in pPresentIds specifies the present id to be associated with the presentation of the swapchain with the same index in the vkQueuePresentKHR call.

For applications to be able to reference specific presentation events queued by a call to vkQueuePresentKHR, an identifier needs to be associated with them.

When the VkSurfaceCapabilitiesPresentId2KHR surface capability is present for a surface, applications can include the VkPresentId2KHR structure in the pNext chain of the VkPresentInfoKHR structure to associate an identifier with each presentation request. The pPresentIds provides an identifier for the swapchain present at the corresponding index in VkPresentInfoKHR’s pSwapchains array.

If this presentId is non-zero, then the application can later use this value to refer to that image presentation. A value of zero indicates that this presentation has no associated presentId. A non-zero presentId must be greater than any non-zero presentId passed previously by the application for the same swapchain.

If a non-zero presentId was provided, this may be used with vkWaitForPresent2KHR for the application to synchronize against the presentation engine’s processing of the presentation request.