Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
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
- 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.
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
- getPhysicalDeviceCalibrateableTimeDomainsEXT :: forall io. MonadIO io => PhysicalDevice -> io (Result, "timeDomains" ::: Vector TimeDomainEXT)
- getCalibratedTimestampsEXT :: forall io. MonadIO io => Device -> ("timestampInfos" ::: Vector CalibratedTimestampInfoEXT) -> io ("timestamps" ::: Vector Word64, "maxDeviation" ::: Word64)
- data CalibratedTimestampInfoEXT = CalibratedTimestampInfoEXT {}
- newtype TimeDomainEXT where
- type EXT_CALIBRATED_TIMESTAMPS_SPEC_VERSION = 2
- pattern EXT_CALIBRATED_TIMESTAMPS_SPEC_VERSION :: forall a. Integral a => a
- type EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME = "VK_EXT_calibrated_timestamps"
- pattern EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
Documentation
getPhysicalDeviceCalibrateableTimeDomainsEXT Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> io (Result, "timeDomains" ::: Vector TimeDomainEXT) |
vkGetPhysicalDeviceCalibrateableTimeDomainsEXT - 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)
-
physicalDevice
must be a validPhysicalDevice
handle
-
pTimeDomainCount
must be a valid pointer to auint32_t
value -
If the value referenced by
pTimeDomainCount
is not0
, andpTimeDomains
is notNULL
,pTimeDomains
must be a valid pointer to an array ofpTimeDomainCount
TimeDomainEXT
values
Return Codes
See Also
getCalibratedTimestampsEXT Source #
:: forall io. MonadIO io | |
=> Device |
|
-> ("timestampInfos" ::: Vector CalibratedTimestampInfoEXT) |
|
-> io ("timestamps" ::: Vector Word64, "maxDeviation" ::: Word64) |
vkGetCalibratedTimestampsEXT - Query calibrated timestamps
Description
Note
The maximum deviation may vary between calls to
getCalibratedTimestampsEXT
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
- The
timeDomain
value of eachCalibratedTimestampInfoEXT
inpTimestampInfos
must be unique
Valid Usage (Implicit)
-
device
must be a validDevice
handle
-
pTimestampInfos
must be a valid pointer to an array oftimestampCount
validCalibratedTimestampInfoEXT
structures -
pTimestamps
must be a valid pointer to an array oftimestampCount
uint64_t
values -
pMaxDeviation
must be a valid pointer to auint64_t
value -
timestampCount
must be greater than0
Return Codes
See Also
VK_EXT_calibrated_timestamps,
CalibratedTimestampInfoEXT
, Device
data CalibratedTimestampInfoEXT Source #
VkCalibratedTimestampInfoEXT - Structure specifying the input parameters of a calibrated timestamp query
Valid Usage (Implicit)
See Also
VK_EXT_calibrated_timestamps,
StructureType
, TimeDomainEXT
,
getCalibratedTimestampsEXT
CalibratedTimestampInfoEXT | |
|
Instances
newtype TimeDomainEXT Source #
VkTimeDomainEXT - Supported time domains
Description
Note
An implementation supporting VK_EXT_calibrated_timestamps
will use the
same time domain for all its Queue
so that
timestamp values reported for TIME_DOMAIN_DEVICE_EXT
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,
CalibratedTimestampInfoEXT
,
getPhysicalDeviceCalibrateableTimeDomainsEXT
pattern TIME_DOMAIN_DEVICE_EXT :: TimeDomainEXT |
|
pattern TIME_DOMAIN_CLOCK_MONOTONIC_EXT :: TimeDomainEXT |
|
pattern TIME_DOMAIN_CLOCK_MONOTONIC_RAW_EXT :: TimeDomainEXT |
|
pattern TIME_DOMAIN_QUERY_PERFORMANCE_COUNTER_EXT :: TimeDomainEXT |
|
Instances
pattern EXT_CALIBRATED_TIMESTAMPS_SPEC_VERSION :: forall a. Integral a => a Source #
type EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME = "VK_EXT_calibrated_timestamps" Source #
pattern EXT_CALIBRATED_TIMESTAMPS_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #