vkGetRefreshCycleDurationGOOGLE - Obtain the RC duration of the PE’s display

Parameters

• Device is the device associated with swapchain.

• swapchain is the swapchain to obtain the refresh duration for.
• pDisplayTimingProperties is a pointer to a RefreshCycleDurationGOOGLE structure.

Valid Usage (Implicit)

• Device must be a valid Device handle

• swapchain must be a valid SwapchainKHR handle
• pDisplayTimingProperties must be a valid pointer to a RefreshCycleDurationGOOGLE structure
• Both of Device, and swapchain must have been created, allocated, or retrieved from the same Instance

Host Synchronization

• Host access to swapchain must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_DEVICE_LOST
• ERROR_SURFACE_LOST_KHR

See Also

Device, RefreshCycleDurationGOOGLE, SwapchainKHR

vkGetPastPresentationTimingGOOGLE - Obtain timing of a previously-presented image

Parameters

• Device is the device associated with swapchain.

• swapchain is the swapchain to obtain presentation timing information duration for.
• pPresentationTimingCount is a pointer to an integer related to the number of PastPresentationTimingGOOGLE structures to query, as described below.
• pPresentationTimings is either NULL or a pointer to an array of PastPresentationTimingGOOGLE structures.

Description

If pPresentationTimings is NULL, then the number of newly-available timing records for the given swapchain is returned in pPresentationTimingCount. Otherwise, pPresentationTimingCount must point to a variable set by the user to the number of elements in the pPresentationTimings array, and on return the variable is overwritten with the number of structures actually written to pPresentationTimings. If the value of pPresentationTimingCount is less than the number of newly-available timing records, at most pPresentationTimingCount structures will be written. If pPresentationTimingCount is smaller than the number of newly-available timing records for the given swapchain, INCOMPLETE will be returned instead of SUCCESS to indicate that not all the available values were returned.

Valid Usage (Implicit)

• Device must be a valid Device handle

• swapchain must be a valid SwapchainKHR handle
• pPresentationTimingCount must be a valid pointer to a uint32_t value
• If the value referenced by pPresentationTimingCount is not 0, and pPresentationTimings is not NULL, pPresentationTimings must be a valid pointer to an array of pPresentationTimingCount PastPresentationTimingGOOGLE structures
• Both of Device, and swapchain must have been created, allocated, or retrieved from the same Instance

Host Synchronization

• Host access to swapchain must be externally synchronized

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_DEVICE_LOST
• ERROR_OUT_OF_DATE_KHR
• ERROR_SURFACE_LOST_KHR

See Also

Device, PastPresentationTimingGOOGLE, SwapchainKHR

VkRefreshCycleDurationGOOGLE - Structure containing the RC duration of a display

See Also

getRefreshCycleDurationGOOGLE

VkPastPresentationTimingGOOGLE - Structure containing timing information about a previously-presented image

Description

The results for a given swapchain and presentID are only returned once from getPastPresentationTimingGOOGLE.

The application can use the PastPresentationTimingGOOGLE values to occasionally adjust its timing. For example, if actualPresentTime is later than expected (e.g. one refreshDuration late), the application may increase its target IPD to a higher multiple of refreshDuration (e.g. decrease its frame rate from 60Hz to 30Hz). If actualPresentTime and earliestPresentTime are consistently different, and if presentMargin is consistently large enough, the application may decrease its target IPD to a smaller multiple of refreshDuration (e.g. increase its frame rate from 30Hz to 60Hz). If actualPresentTime and earliestPresentTime are same, and if presentMargin is consistently high, the application may delay the start of its input-render-present loop in order to decrease the latency between user input and the corresponding present (always leaving some margin in case a new image takes longer to render than the previous image). An application that desires its target IPD to always be the same as refreshDuration, can also adjust features until actualPresentTime is never late and presentMargin is satisfactory.

See Also

getPastPresentationTimingGOOGLE

VkPresentTimesInfoGOOGLE - The earliest time each image should be presented

Valid Usage

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

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE

• If pTimes is not NULL, pTimes must be a valid pointer to an array of swapchainCount PresentTimeGOOGLE structures
• swapchainCount must be greater than 0

See Also

PresentTimeGOOGLE, StructureType

VkPresentTimeGOOGLE - The earliest time image should be presented

See Also

PresentTimesInfoGOOGLE

VkSwapchainKHR - Opaque handle to a swapchain object

Description

A swapchain is an abstraction for an array of presentable images that are associated with a surface. The presentable images are represented by Image objects created by the platform. One image (which can be an array image for multiview/stereoscopic-3D surfaces) is displayed at a time, but multiple images can be queued for presentation. An application renders to the image, and then queues the image for presentation to the surface.

A native window cannot be associated with more than one non-retired swapchain at a time. Further, swapchains cannot be created for native windows that have a non-Vulkan graphics API surface associated with them.

Note

The presentation engine is an abstraction for the platform’s compositor or display engine.

The presentation engine may be synchronous or asynchronous with respect to the application and/or logical device.

Some implementations may use the device’s graphics queue or dedicated presentation hardware to perform presentation.

The presentable images of a swapchain are owned by the presentation engine. An application can acquire use of a presentable image from the presentation engine. Use of a presentable image must occur only after the image is returned by acquireNextImageKHR, and before it is presented by queuePresentKHR. This includes transitioning the image layout and rendering commands.

An application can acquire use of a presentable image with acquireNextImageKHR. After acquiring a presentable image and before modifying it, the application must use a synchronization primitive to ensure that the presentation engine has finished reading from the image. The application can then transition the image’s layout, queue rendering commands to it, etc. Finally, the application presents the image with queuePresentKHR, which releases the acquisition of the image.

The presentation engine controls the order in which presentable images are acquired for use by the application.

Note

This allows the platform to handle situations which require out-of-order return of images after presentation. At the same time, it allows the application to generate command buffers referencing all of the images in the swapchain at initialization time, rather than in its main loop.

See Also

AcquireNextImageInfoKHR, BindImageMemorySwapchainInfoKHR, ImageSwapchainCreateInfoKHR, PresentInfoKHR, SwapchainCreateInfoKHR, acquireFullScreenExclusiveModeEXT, acquireNextImageKHR, createSharedSwapchainsKHR, createSwapchainKHR, destroySwapchainKHR, getPastPresentationTimingGOOGLE, getRefreshCycleDurationGOOGLE, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, releaseFullScreenExclusiveModeEXT, setHdrMetadataEXT, setLocalDimmingAMD