vulkan
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_EXT_calibrated_timestamps

Description

Name

VK_EXT_calibrated_timestamps - device extension

VK_EXT_calibrated_timestamps

Name String
VK_EXT_calibrated_timestamps
Extension Type
Device extension
Registered Extension Number
185
Revision
2
Ratification Status
Not ratified
Extension and Version Dependencies
VK_KHR_get_physical_device_properties2 or Version 1.1
Deprecation State
Contact
Extension Proposal
VK_EXT_calibrated_timestamps

Other Extension Metadata

Last Modified Date
2018-10-04
IP Status
No known IP claims.
Contributors
  • Matthaeus G. Chajdas, AMD
  • Alan Harrison, AMD
  • Derrick Owens, AMD
  • Daniel Rakos, AMD
  • Faith Ekstrand, Intel
  • Keith Packard, Valve

Description

This extension provides an interface to query calibrated timestamps obtained quasi simultaneously from two time domains.

Promotion to VK_KHR_calibrated_timestamps

All functionality in this extension is included in VK_KHR_calibrated_timestamps, with the suffix changed to KHR. The original enum names are still available as aliases of the KHR functionality.

New Commands

New Structures

New Enums

New Enum Constants

Version History

  • Revision 2, 2021-03-16 (Lionel Landwerlin)

    • Specify requirement on device timestamps
  • Revision 1, 2018-10-04 (Daniel Rakos)

    • Internal revisions.

See Also

CalibratedTimestampInfoEXT, TimeDomainEXT, getCalibratedTimestampsEXT, getPhysicalDeviceCalibrateableTimeDomainsEXT

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

getCalibratedTimestampsEXT :: MonadIO io => Device -> ("timestampInfos" ::: Vector CalibratedTimestampInfoKHR) -> io ("timestamps" ::: Vector Word64, "maxDeviation" ::: Word64) Source #

type EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME = "VK_EXT_calibrated_timestamps" Source #

data CalibratedTimestampInfoKHR Source #

VkCalibratedTimestampInfoKHR - Structure specifying the input parameters of a calibrated timestamp query

Valid Usage (Implicit)

See Also

VK_EXT_calibrated_timestamps, VK_KHR_calibrated_timestamps, StructureType, TimeDomainKHR, getCalibratedTimestampsEXT, getCalibratedTimestampsKHR

Constructors

CalibratedTimestampInfoKHR 

Fields

Instances

Instances details
Storable CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Show CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Eq CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

FromCStruct CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

ToCStruct CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Zero CalibratedTimestampInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

getPhysicalDeviceCalibrateableTimeDomainsKHR Source #

Arguments

:: forall io. MonadIO io 
=> PhysicalDevice

physicalDevice is the physical device from which to query the set of calibrateable time domains.

-> io (Result, "timeDomains" ::: Vector TimeDomainKHR) 

vkGetPhysicalDeviceCalibrateableTimeDomainsKHR - Query calibrateable time domains

Description

If pTimeDomains is NULL, then the number of calibrateable time domains supported for the given physicalDevice is returned in pTimeDomainCount. Otherwise, pTimeDomainCount must point to a variable set by the user to the number of elements in the pTimeDomains array, and on return the variable is overwritten with the number of values actually written to pTimeDomains. If the value of pTimeDomainCount is less than the number of calibrateable time domains supported, at most pTimeDomainCount values will be written to pTimeDomains, and INCOMPLETE will be returned instead of SUCCESS, to indicate that not all the available time domains were returned.

Valid Usage (Implicit)

  • pTimeDomainCount must be a valid pointer to a uint32_t value
  • If the value referenced by pTimeDomainCount is not 0, and pTimeDomains is not NULL, pTimeDomains must be a valid pointer to an array of pTimeDomainCount TimeDomainKHR values

Return Codes

Success
Failure

See Also

VK_EXT_calibrated_timestamps, VK_KHR_calibrated_timestamps, PhysicalDevice, TimeDomainKHR

getCalibratedTimestampsKHR Source #

Arguments

:: forall io. MonadIO io 
=> Device

device is the logical device used to perform the query.

-> ("timestampInfos" ::: Vector CalibratedTimestampInfoKHR)

pTimestampInfos is a pointer to an array of timestampCount CalibratedTimestampInfoKHR structures, describing the time domains the calibrated timestamps should be captured from.

-> io ("timestamps" ::: Vector Word64, "maxDeviation" ::: Word64) 

vkGetCalibratedTimestampsKHR - Query calibrated timestamps

Description

Note

The maximum deviation may vary between calls to getCalibratedTimestampsKHR even for the same set of time domains due to implementation and platform specific reasons. It is the application’s responsibility to assess whether the returned maximum deviation makes the timestamp values suitable for any particular purpose and can choose to re-issue the timestamp calibration call pursuing a lower deviation value.

Calibrated timestamp values can be extrapolated to estimate future coinciding timestamp values, however, depending on the nature of the time domains and other properties of the platform extrapolating values over a sufficiently long period of time may no longer be accurate enough to fit any particular purpose, so applications are expected to re-calibrate the timestamps on a regular basis.

Valid Usage

Valid Usage (Implicit)

  • device must be a valid Device handle
  • pTimestampInfos must be a valid pointer to an array of timestampCount valid CalibratedTimestampInfoKHR structures
  • pTimestamps must be a valid pointer to an array of timestampCount uint64_t values
  • pMaxDeviation must be a valid pointer to a uint64_t value
  • timestampCount must be greater than 0

Return Codes

Success
Failure

See Also

VK_EXT_calibrated_timestamps, VK_KHR_calibrated_timestamps, CalibratedTimestampInfoKHR, Device

newtype TimeDomainKHR Source #

VkTimeDomainKHR - Supported time domains

Description

Note

An implementation supporting VK_KHR_calibrated_timestamps or VK_EXT_calibrated_timestamps will use the same time domain for all its Queue so that timestamp values reported for TIME_DOMAIN_DEVICE_KHR can be matched to any timestamp captured through cmdWriteTimestamp or cmdWriteTimestamp2 .

struct timespec tv;
clock_gettime(CLOCK_MONOTONIC, &tv);
return tv.tv_nsec + tv.tv_sec*1000000000ull;
struct timespec tv;
clock_gettime(CLOCK_MONOTONIC_RAW, &tv);
return tv.tv_nsec + tv.tv_sec*1000000000ull;
LARGE_INTEGER counter;
QueryPerformanceCounter(&counter);
return counter.QuadPart;

See Also

VK_EXT_calibrated_timestamps, VK_KHR_calibrated_timestamps, CalibratedTimestampInfoKHR, getPhysicalDeviceCalibrateableTimeDomainsEXT, getPhysicalDeviceCalibrateableTimeDomainsKHR

Constructors

TimeDomainKHR Int32 

Bundled Patterns

pattern TIME_DOMAIN_CLOCK_MONOTONIC_KHR :: TimeDomainKHR

TIME_DOMAIN_CLOCK_MONOTONIC_KHR specifies the CLOCK_MONOTONIC time domain available on POSIX platforms. Timestamp values in this time domain are in units of nanoseconds and are comparable with platform timestamp values captured using the POSIX clock_gettime API as computed by this example:

pattern TIME_DOMAIN_CLOCK_MONOTONIC_RAW_KHR :: TimeDomainKHR

TIME_DOMAIN_CLOCK_MONOTONIC_RAW_KHR specifies the CLOCK_MONOTONIC_RAW time domain available on POSIX platforms. Timestamp values in this time domain are in units of nanoseconds and are comparable with platform timestamp values captured using the POSIX clock_gettime API as computed by this example:

pattern TIME_DOMAIN_DEVICE_KHR :: TimeDomainKHR

TIME_DOMAIN_DEVICE_KHR specifies the device time domain. Timestamp values in this time domain use the same units and are comparable with device timestamp values captured using cmdWriteTimestamp or cmdWriteTimestamp2 and are defined to be incrementing according to the timestampPeriod of the device.

pattern TIME_DOMAIN_QUERY_PERFORMANCE_COUNTER_KHR :: TimeDomainKHR

TIME_DOMAIN_QUERY_PERFORMANCE_COUNTER_KHR specifies the performance counter (QPC) time domain available on Windows. Timestamp values in this time domain are in the same units as those provided by the Windows QueryPerformanceCounter API and are comparable with platform timestamp values captured using that API as computed by this example:

Instances

Instances details
Storable TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Read TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Show TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Eq TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Ord TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps

Zero TimeDomainKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_calibrated_timestamps