GPUCommandEncoder: writeTimestamp() method

Secure contextAvailable in 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.

[!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 type is "timestamp"
• The queryIndex value is less than the count.

Examples

// …

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

// …

commandEncoder.writeTimestamp(querySet, 0);

// …

Specifications

Browser compatibility

See also

• The WebGPU API