GPUCommandEncoder: writeTimestamp() method
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.
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
GPUQuerySetobject 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-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
| Specification |
|---|
| WebGPU # dom-gpucommandencoder-writetimestamp |
Browser compatibility
| desktop | mobile | server | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
writeTimestamp | ||||||||||||
See also
- The WebGPU API