HORIZON HASKELLDocslts/ghc-9.14.x45dd5372026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · 45dd537 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_KHR_present_id

Name

VK_KHR_present_id - device extension

VK_KHR_present_id

Name String

VK_KHR_present_id

Extension Type

Device extension

Registered Extension Number

295

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_swapchain

and

VK_KHR_get_physical_device_properties2      or

Vulkan Version 1.1

Contact

Other Extension Metadata

Last Modified Date

2019-05-15

IP Status

No known IP claims.

Contributors
  • Keith Packard, Valve

  • Ian Elliott, Google

  • Alon Or-bach, Samsung

Description

This device extension allows an application that uses the VK_KHR_swapchain extension to provide an identifier for present operations on a swapchain. An application can use this to reference specific present operations in other extensions.

New Structures

New Enum Constants

Issues

None.

Version History

  • Revision 1, 2019-05-15 (Keith Packard)

    • Initial version

See Also

No cross-references are available

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

  • 4 types
  • Packagevulkan-3.27
  • Exports6
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceVK_KHR_present_id.hs

VkPhysicalDevicePresentIdFeaturesKHR - Structure indicating support for present id

Members

This structure describes the following feature:

Description

If the PhysicalDevicePresentIdFeaturesKHR 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 PhysicalDevicePresentIdFeaturesKHR, 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

See Also

VK_KHR_present_id, Bool32, StructureType

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero
datadata PresentIdKHR
#

VkPresentIdKHR - 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 presentId feature is enabled, applications can include the PresentIdKHR structure in the pNext chain of the PresentInfoKHR structure to supply identifiers.

Each SwapchainKHR has a presentId associated with it. This value is initially zero when the SwapchainKHR is created.

When a PresentIdKHR structure with a non-NULL pPresentIds is included in the pNext chain of a PresentInfoKHR structure, each pSwapchains entry has a presentId associated in the pPresentIds array at the same index as the swapchain in the 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.

There is no requirement for any precise timing relationship between the presentation of the image to the user and the update of the presentId value, but implementations should make this as close as possible to the presentation of the first pixel in the new image to the user.

Valid Usage

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

Valid Usage (Implicit)

  • 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

See Also

VK_KHR_present_id, StructureType

Constructors

Instances4Show, FromCStruct, ToCStruct, Zero