vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_present_id

Description

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
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

PhysicalDevicePresentIdFeaturesKHR, PresentIdKHR

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.

Synopsis

Documentation

data PhysicalDevicePresentIdFeaturesKHR Source #

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. PhysicalDevicePresentIdFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

See Also

VK_KHR_present_id, Bool32, StructureType

Constructors

PhysicalDevicePresentIdFeaturesKHR 

Fields

Instances

Instances details
Storable PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

sizeOf :: PhysicalDevicePresentIdFeaturesKHR -> Int #

alignment :: PhysicalDevicePresentIdFeaturesKHR -> Int #

peekElemOff :: Ptr PhysicalDevicePresentIdFeaturesKHR -> Int -> IO PhysicalDevicePresentIdFeaturesKHR #

pokeElemOff :: Ptr PhysicalDevicePresentIdFeaturesKHR -> Int -> PhysicalDevicePresentIdFeaturesKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO PhysicalDevicePresentIdFeaturesKHR #

pokeByteOff :: Ptr b -> Int -> PhysicalDevicePresentIdFeaturesKHR -> IO () #

peek :: Ptr PhysicalDevicePresentIdFeaturesKHR -> IO PhysicalDevicePresentIdFeaturesKHR #

poke :: Ptr PhysicalDevicePresentIdFeaturesKHR -> PhysicalDevicePresentIdFeaturesKHR -> IO () #

Show PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

showsPrec :: Int -> PhysicalDevicePresentIdFeaturesKHR -> ShowS #

show :: PhysicalDevicePresentIdFeaturesKHR -> String #

showList :: [PhysicalDevicePresentIdFeaturesKHR] -> ShowS #

Eq PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

(==) :: PhysicalDevicePresentIdFeaturesKHR -> PhysicalDevicePresentIdFeaturesKHR -> Bool #

(/=) :: PhysicalDevicePresentIdFeaturesKHR -> PhysicalDevicePresentIdFeaturesKHR -> Bool #

FromCStruct PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

peekCStruct :: Ptr PhysicalDevicePresentIdFeaturesKHR -> IO PhysicalDevicePresentIdFeaturesKHR Source #

ToCStruct PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

withCStruct :: PhysicalDevicePresentIdFeaturesKHR -> (Ptr PhysicalDevicePresentIdFeaturesKHR -> IO b) -> IO b Source #

pokeCStruct :: Ptr PhysicalDevicePresentIdFeaturesKHR -> PhysicalDevicePresentIdFeaturesKHR -> IO b -> IO b Source #

withZeroCStruct :: (Ptr PhysicalDevicePresentIdFeaturesKHR -> IO b) -> IO b Source #

pokeZeroCStruct :: Ptr PhysicalDevicePresentIdFeaturesKHR -> IO b -> IO b Source #

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero PhysicalDevicePresentIdFeaturesKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

zero :: PhysicalDevicePresentIdFeaturesKHR Source #

data PresentIdKHR Source #

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 set to 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 presentIds entry must be greater than any previous presentIds entry passed for the associated pSwapchains entry

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

See Also

VK_KHR_present_id, StructureType

Constructors

PresentIdKHR 

Fields

  • swapchainCount :: Word32

    swapchainCount is the number of swapchains being presented to the queuePresentKHR command.

  • presentIds :: Vector Word64

    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 queuePresentKHR call.

Instances

Instances details
Show PresentIdKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

showsPrec :: Int -> PresentIdKHR -> ShowS #

show :: PresentIdKHR -> String #

showList :: [PresentIdKHR] -> ShowS #

FromCStruct PresentIdKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

peekCStruct :: Ptr PresentIdKHR -> IO PresentIdKHR Source #

ToCStruct PresentIdKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

withCStruct :: PresentIdKHR -> (Ptr PresentIdKHR -> IO b) -> IO b Source #

pokeCStruct :: Ptr PresentIdKHR -> PresentIdKHR -> IO b -> IO b Source #

withZeroCStruct :: (Ptr PresentIdKHR -> IO b) -> IO b Source #

pokeZeroCStruct :: Ptr PresentIdKHR -> IO b -> IO b Source #

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero PresentIdKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_present_id

Methods

zero :: PresentIdKHR Source #

type KHR_PRESENT_ID_SPEC_VERSION = 1 Source #

pattern KHR_PRESENT_ID_SPEC_VERSION :: forall a. Integral a => a Source #

type KHR_PRESENT_ID_EXTENSION_NAME = "VK_KHR_present_id" Source #

pattern KHR_PRESENT_ID_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #