GPUCommandEncoder: writeTimestamp() method
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.
Note: This feature is available in Web Workers.
The writeTimestamp()
method of the
GPUCommandEncoder
interface encodes a command that writes a timestamp into a GPUQuerySet
once the previous commands recorded into the same queued GPUCommandBuffer
have been executed by the GPU.
Syntax
writeTimestamp(querySet, queryIndex)
Parameters
querySet
-
A
GPUQuerySet
object representing the query set that will store the timestamp values. queryIndex
-
A number representing the index of the query in the query set.
Return value
None (Undefined
).
Validation
The following criteria must be met when calling writeTimestamp()
, otherwise a GPUValidationError
is generated and the GPUCommandEncoder
becomes invalid:
- The
timestamp-query
feature is enabled in theGPUDevice
. - The
querySet
GPUQuerySet.type
is"timestamp"
- The
queryIndex
value is less than theGPUQuerySet.count
.
Examples
// ...
const querySet = device.createQuerySet({
type: "timestamp",
count: 32,
});
// ...
commandEncoder.writeTimestamp(querySet, 0);
// ...
Specifications
No specification found
No specification data found for api.GPUCommandEncoder.writeTimestamp
.
Check for problems with this page or contribute a missing spec_url
to mdn/browser-compat-data. Also make sure the specification is included in w3c/browser-specs.
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API