Vulkan.Extensions.VK_KHR_present_id2

VkPhysicalDevicePresentId2FeaturesKHR - Structure indicating support for present id 2

Members

This structure describes the following feature:

Description

If the PhysicalDevicePresentId2FeaturesKHR 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 PhysicalDevicePresentId2FeaturesKHR, 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.

Structure Chaining

Extends the structures

• DeviceCreateInfo

• PhysicalDeviceFeatures2

See Also

VK_KHR_present_id2, Bool32, StructureType

VkPresentId2KHR - The list of presentation identifiers

Description

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

When the SurfaceCapabilitiesPresentId2KHR surface capability is present for a surface, applications can include the PresentId2KHR structure in the pNext chain of the PresentInfoKHR structure to associate an identifier with each presentation request. The pPresentIds provides an identifier for the swapchain present at the corresponding index in PresentInfoKHR’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 waitForPresent2KHR for the application to synchronize against the presentation engine’s processing of the presentation request.

The ID namespace used by this extension must be shared with other extensions that allow the application to provide a 64-bit monotonically increasing presentation ID, such as the original VK_KHR_present_id.

This is to allow existing extensions that depend on VK_KHR_present_id to use VK_KHR_present_id2 provided IDs without change, as well as to simplify writing future extensions that require application provided presentation IDs.

Valid Usage

• swapchainCount must be the same value as PresentInfoKHR::swapchainCount, where this PresentId2KHR is in the pNext chain of the PresentInfoKHR structure

• Each non-zero entry in presentIds must be greater than all previously submitted present ids for the associated swapchain in PresentInfoKHR::pSwapchains

• The swapchain must have been created with SWAPCHAIN_CREATE_PRESENT_ID_2_BIT_KHR bit set in the SwapchainCreateFlagBitsKHR field

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PRESENT_ID_2_KHR

• If pPresentIds is not NULL, pPresentIds must be a valid pointer to an array of swapchainCount uint64_t values

• swapchainCount must be greater than 0

Structure Chaining

Extends the structure

• PresentInfoKHR

See Also

VK_KHR_present_id2, StructureType

VkSurfaceCapabilitiesPresentId2KHR - Structure describing presentation-ID capabilities of a surface

Description

This structure can be included in the pNext chain of SurfaceCapabilities2KHR to determine support for present-wait. If presentId2Supported is FALSE, it indicates that attaching an ID to presentation requests is not possible for this surface.

Applications must not attempt to include PresentId2KHR in the pNext chain of a PresentInfoKHR if presentId2Supported is FALSE.

Structure Chaining

Extends the structure

• SurfaceCapabilities2KHR

See Also

VK_KHR_present_id2, Bool32, StructureType

VkSwapchainCreateFlagBitsKHR - Bitmask controlling swapchain creation

Description

• SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR specifies that images created from the swapchain (i.e. with the swapchain member of ImageSwapchainCreateInfoKHR set to this swapchain’s handle) must use IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT.

• SWAPCHAIN_CREATE_PROTECTED_BIT_KHR specifies that images created from the swapchain are protected images.

• SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR specifies that the images of the swapchain can be used to create a ImageView with a different format than what the swapchain was created with. The list of allowed image view formats is specified by adding a ImageFormatListCreateInfo structure to the pNext chain of SwapchainCreateInfoKHR. In addition, this flag also specifies that the swapchain can be created with usage flags that are not supported for the format the swapchain is created with but are supported for at least one of the allowed image view formats.

• SWAPCHAIN_CREATE_DEFERRED_MEMORY_ALLOCATION_BIT_KHR specifies that the implementation may defer allocation of memory associated with each swapchain image until its index is to be returned from acquireNextImageKHR or acquireNextImage2KHR for the first time.

• SWAPCHAIN_CREATE_PRESENT_ID_2_BIT_KHR specifies that applications can include the PresentId2KHR structure in the pNext chain of the PresentInfoKHR structure to associate an identifier with each presentation request.

• SWAPCHAIN_CREATE_PRESENT_WAIT_2_BIT_KHR specifies that applications can use waitForPresent2KHR to wait for the presentation engine to have begun presentation of the presentation request associated with PresentWait2InfoKHR::presentId on swapchain.

• SWAPCHAIN_CREATE_PRESENT_TIMING_BIT_EXT specifies that features supported by the swapchain device in PhysicalDevicePresentTimingFeaturesEXT can be used to collect timing information or schedule presentation requests at specific times.

See Also

VK_KHR_swapchain, SwapchainCreateFlagsKHR