Graphics.Vulkan.Extensions.VK_GOOGLE_display_timing

Documentation

pattern VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE :: VkStructureType

pattern VK_GOOGLE_DISPLAY_TIMING_SPEC_VERSION :: Integral a => a

pattern VK_GOOGLE_DISPLAY_TIMING_EXTENSION_NAME :: (Eq a, IsString a) => a

vkGetRefreshCycleDurationGOOGLE :: ("device" ::: VkDevice) -> ("swapchain" ::: VkSwapchainKHR) -> ("pDisplayTimingProperties" ::: Ptr VkRefreshCycleDurationGOOGLE) -> IO VkResult

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 an instance of the VkRefreshCycleDurationGOOGLE structure.

Description

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• swapchain must be a valid VkSwapchainKHR handle
• pDisplayTimingProperties must be a valid pointer to a VkRefreshCycleDurationGOOGLE structure
• Both of device, and swapchain must have been created, allocated, or retrieved from the same VkInstance

Host Synchronization

• Host access to swapchain must be externally synchronized

Return Codes

Success

- VK_SUCCESS

Failure

- VK_ERROR_DEVICE_LOST

• VK_ERROR_SURFACE_LOST_KHR

See Also

VkDevice, VkRefreshCycleDurationGOOGLE, VkSwapchainKHR

vkGetPastPresentationTimingGOOGLE :: ("device" ::: VkDevice) -> ("swapchain" ::: VkSwapchainKHR) -> ("pPresentationTimingCount" ::: Ptr Word32) -> ("pPresentationTimings" ::: Ptr VkPastPresentationTimingGOOGLE) -> IO VkResult

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 VkPastPresentationTimingGOOGLE structures to query, as described below.
• pPresentationTimings is either NULL or a pointer to an an array of VkPastPresentationTimingGOOGLE 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, VK_INCOMPLETE will be returned instead of VK_SUCCESS to indicate that not all the available values were returned.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• swapchain must be a valid VkSwapchainKHR 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 VkPastPresentationTimingGOOGLE structures
• Both of device, and swapchain must have been created, allocated, or retrieved from the same VkInstance

Host Synchronization

• Host access to swapchain must be externally synchronized

Return Codes

Success

- VK_SUCCESS

• VK_INCOMPLETE

Failure

- VK_ERROR_DEVICE_LOST

• VK_ERROR_OUT_OF_DATE_KHR

• VK_ERROR_SURFACE_LOST_KHR

See Also

VkDevice, VkPastPresentationTimingGOOGLE, VkSwapchainKHR

data VkRefreshCycleDurationGOOGLE

VkRefreshCycleDurationGOOGLE - Structure containing the RC duration of a display

Description

See Also

vkGetRefreshCycleDurationGOOGLE

Constructors

VkRefreshCycleDurationGOOGLE

Fields

• vkRefreshDuration :: Word64

  refreshDuration is the number of nanoseconds from the start of one refresh cycle to the next.

Instances

Eq VkRefreshCycleDurationGOOGLE

Methods

(==) :: VkRefreshCycleDurationGOOGLE -> VkRefreshCycleDurationGOOGLE -> Bool

(/=) :: VkRefreshCycleDurationGOOGLE -> VkRefreshCycleDurationGOOGLE -> Bool

Show VkRefreshCycleDurationGOOGLE

Methods

showsPrec :: Int -> VkRefreshCycleDurationGOOGLE -> ShowS

show :: VkRefreshCycleDurationGOOGLE -> String

showList :: [VkRefreshCycleDurationGOOGLE] -> ShowS

Storable VkRefreshCycleDurationGOOGLE

Methods

sizeOf :: VkRefreshCycleDurationGOOGLE -> Int

alignment :: VkRefreshCycleDurationGOOGLE -> Int

peekElemOff :: Ptr VkRefreshCycleDurationGOOGLE -> Int -> IO VkRefreshCycleDurationGOOGLE

pokeElemOff :: Ptr VkRefreshCycleDurationGOOGLE -> Int -> VkRefreshCycleDurationGOOGLE -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkRefreshCycleDurationGOOGLE

pokeByteOff :: Ptr b -> Int -> VkRefreshCycleDurationGOOGLE -> IO ()

peek :: Ptr VkRefreshCycleDurationGOOGLE -> IO VkRefreshCycleDurationGOOGLE

poke :: Ptr VkRefreshCycleDurationGOOGLE -> VkRefreshCycleDurationGOOGLE -> IO ()

data VkPastPresentationTimingGOOGLE

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

Description

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

The application can use the VkPastPresentationTimingGOOGLE 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

vkGetPastPresentationTimingGOOGLE

Constructors

VkPastPresentationTimingGOOGLE

Fields

• vkPresentID :: Word32

  presentID is an application-provided value that was given to a previous vkQueuePresentKHR command via VkPresentTimeGOOGLE::presentID (see below). It can be used to uniquely identify a previous present with the vkQueuePresentKHR command.

• vkDesiredPresentTime :: Word64

  desiredPresentTime is an application-provided value that was given to a previous vkQueuePresentKHR command via VkPresentTimeGOOGLE::desiredPresentTime. If non-zero, it was used by the application to indicate that an image not be presented any sooner than desiredPresentTime.

• vkActualPresentTime :: Word64

  actualPresentTime is the time when the image of the swapchain was actually displayed.

• vkEarliestPresentTime :: Word64

  earliestPresentTime is the time when the image of the swapchain could have been displayed. This may differ from actualPresentTime if the application requested that the image be presented no sooner than VkPresentTimeGOOGLE::desiredPresentTime.

• vkPresentMargin :: Word64

  presentMargin is an indication of how early the vkQueuePresentKHR command was processed compared to how soon it needed to be processed, and still be presented at earliestPresentTime.

Instances

Eq VkPastPresentationTimingGOOGLE

Methods

(==) :: VkPastPresentationTimingGOOGLE -> VkPastPresentationTimingGOOGLE -> Bool

(/=) :: VkPastPresentationTimingGOOGLE -> VkPastPresentationTimingGOOGLE -> Bool

Show VkPastPresentationTimingGOOGLE

Methods

showsPrec :: Int -> VkPastPresentationTimingGOOGLE -> ShowS

show :: VkPastPresentationTimingGOOGLE -> String

showList :: [VkPastPresentationTimingGOOGLE] -> ShowS

Storable VkPastPresentationTimingGOOGLE

Methods

sizeOf :: VkPastPresentationTimingGOOGLE -> Int

alignment :: VkPastPresentationTimingGOOGLE -> Int

peekElemOff :: Ptr VkPastPresentationTimingGOOGLE -> Int -> IO VkPastPresentationTimingGOOGLE

pokeElemOff :: Ptr VkPastPresentationTimingGOOGLE -> Int -> VkPastPresentationTimingGOOGLE -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkPastPresentationTimingGOOGLE

pokeByteOff :: Ptr b -> Int -> VkPastPresentationTimingGOOGLE -> IO ()

peek :: Ptr VkPastPresentationTimingGOOGLE -> IO VkPastPresentationTimingGOOGLE

poke :: Ptr VkPastPresentationTimingGOOGLE -> VkPastPresentationTimingGOOGLE -> IO ()

data VkPresentTimesInfoGOOGLE

VkPresentTimesInfoGOOGLE - The earliest time each image should be presented

Description

Valid Usage

• swapchainCount must be the same value as VkPresentInfoKHR::swapchainCount, where VkPresentInfoKHR is in the pNext chain of this VkPresentTimesInfoGOOGLE structure.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_PRESENT_TIMES_INFO_GOOGLE

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

See Also

VkPresentTimeGOOGLE, VkStructureType

Constructors

VkPresentTimesInfoGOOGLE

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkSwapchainCount :: Word32

  swapchainCount is the number of swapchains being presented to by this command.

• vkPTimes :: Ptr VkPresentTimeGOOGLE

  pTimes is NULL or a pointer to an array of VkPresentTimeGOOGLE elements with swapchainCount entries. If not NULL, each element of pTimes contains the earliest time to present the image corresponding to the entry in the VkPresentInfoKHR::pImageIndices array.

Instances

Eq VkPresentTimesInfoGOOGLE

Methods

(==) :: VkPresentTimesInfoGOOGLE -> VkPresentTimesInfoGOOGLE -> Bool

(/=) :: VkPresentTimesInfoGOOGLE -> VkPresentTimesInfoGOOGLE -> Bool

Show VkPresentTimesInfoGOOGLE

Methods

showsPrec :: Int -> VkPresentTimesInfoGOOGLE -> ShowS

show :: VkPresentTimesInfoGOOGLE -> String

showList :: [VkPresentTimesInfoGOOGLE] -> ShowS

Storable VkPresentTimesInfoGOOGLE

Methods

sizeOf :: VkPresentTimesInfoGOOGLE -> Int

alignment :: VkPresentTimesInfoGOOGLE -> Int

peekElemOff :: Ptr VkPresentTimesInfoGOOGLE -> Int -> IO VkPresentTimesInfoGOOGLE

pokeElemOff :: Ptr VkPresentTimesInfoGOOGLE -> Int -> VkPresentTimesInfoGOOGLE -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkPresentTimesInfoGOOGLE

pokeByteOff :: Ptr b -> Int -> VkPresentTimesInfoGOOGLE -> IO ()

peek :: Ptr VkPresentTimesInfoGOOGLE -> IO VkPresentTimesInfoGOOGLE

poke :: Ptr VkPresentTimesInfoGOOGLE -> VkPresentTimesInfoGOOGLE -> IO ()

data VkPresentTimeGOOGLE

VkPresentTimeGOOGLE - The earliest time image should be presented

Description

See Also

VkPresentTimesInfoGOOGLE

Constructors

VkPresentTimeGOOGLE

Fields

• vkPresentID :: Word32

  presentID is an application-provided identification value, that can be used with the results of vkGetPastPresentationTimingGOOGLE, in order to uniquely identify this present. In order to be useful to the application, it should be unique within some period of time that is meaningful to the application.

• vkDesiredPresentTime :: Word64

  desiredPresentTime specifies that the image given should not be displayed to the user any earlier than this time. desiredPresentTime is a time in nanoseconds, relative to a monotonically-increasing clock (e.g. CLOCK_MONOTONIC (see clock_gettime(2)) on Android and Linux). A value of zero specifies that the presentation engine may display the image at any time. This is useful when the application desires to provide presentID, but doesn’t need a specific desiredPresentTime.

Instances

Eq VkPresentTimeGOOGLE

Methods

(==) :: VkPresentTimeGOOGLE -> VkPresentTimeGOOGLE -> Bool

(/=) :: VkPresentTimeGOOGLE -> VkPresentTimeGOOGLE -> Bool

Show VkPresentTimeGOOGLE

Methods

showsPrec :: Int -> VkPresentTimeGOOGLE -> ShowS

show :: VkPresentTimeGOOGLE -> String

showList :: [VkPresentTimeGOOGLE] -> ShowS

Storable VkPresentTimeGOOGLE

Methods

sizeOf :: VkPresentTimeGOOGLE -> Int

alignment :: VkPresentTimeGOOGLE -> Int

peekElemOff :: Ptr VkPresentTimeGOOGLE -> Int -> IO VkPresentTimeGOOGLE

pokeElemOff :: Ptr VkPresentTimeGOOGLE -> Int -> VkPresentTimeGOOGLE -> IO ()

peekByteOff :: Ptr b -> Int -> IO VkPresentTimeGOOGLE

pokeByteOff :: Ptr b -> Int -> VkPresentTimeGOOGLE -> IO ()

peek :: Ptr VkPresentTimeGOOGLE -> IO VkPresentTimeGOOGLE

poke :: Ptr VkPresentTimeGOOGLE -> VkPresentTimeGOOGLE -> IO ()