GPUCommandEncoder: writeTimestamp() method
Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting 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 thecompatibility 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 not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
Note: This feature is available inWeb Workers.
ThewriteTimestamp() method of theGPUCommandEncoder interface encodes a command that writes a timestamp into aGPUQuerySet once the previous commands recorded into the same queuedGPUCommandBuffer have been executed by the GPU.
Syntax
writeTimestamp(querySet, queryIndex)Parameters
querySetA
GPUQuerySetobject representing the query set that will store the timestamp values.queryIndexA number representing the index of the query in the query set.
Return value
None (Undefined).
Validation
The following criteria must be met when callingwriteTimestamp(), otherwise aGPUValidationError is generated and theGPUCommandEncoder becomes invalid:
- The
timestamp-queryfeature is enabled in theGPUDevice. - The
querySetGPUQuerySet.typeis"timestamp" - The
queryIndexvalue is less than theGPUQuerySet.count.
Examples
// …const querySet = device.createQuerySet({ type: "timestamp", count: 32,});// …commandEncoder.writeTimestamp(querySet, 0);// …Specifications
This feature does not appear to be defined in any specification.Browser compatibility
See also
- TheWebGPU API