GPUCommandEncoder: writeTimestamp() method

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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.

Note: To use timestamp queries, the timestamp-query feature must be enabled in the GPUDevice.

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 the GPUDevice.
The querySet GPUQuerySet.type is "timestamp"
The queryIndex value is less than the GPUQuerySet.count.

Examples

// ...

const querySet = device.createQuerySet({
  type: "timestamp",
  count: 32,
});

// ...

commandEncoder.writeTimestamp(querySet, 0);

// ...

Specifications

Specification
WebGPU # dom-gpucommandencoder-writetimestamp

Browser compatibility

BCD tables only load in the browser