GPUCommandEncoder: beginComputePass() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能在 Web Workers 中可用。

GPUCommandEncoder 接口的 beginComputePass() 方法用于开始编码一个计算通道,并返回一个 GPUComputePassEncoder 对象,该对象可用于控制计算。

语法

js
beginComputePass()
beginComputePass(descriptor)

参数

descriptor 可选

包含以下属性的对象:

label 可选

一个字符串,提供可用于识别对象的标签,例如在 GPUError 消息或控制台警告中。

timestampWrites 可选

一个对象数组,用于定义时间戳查询值在此通道中写入的位置和时间。这些对象具有以下属性:

querySet

一个类型为 "timestamp"GPUQuerySet 对象,时间戳查询结果将被写入其中。

beginningOfPassWriteIndex

一个数字,指定在 querySet 中用于写入渲染通道开始处时间戳的查询索引。此项是可选的 - 如果未定义,则不会为通道的开始处写入时间戳。

endOfPassWriteIndex

一个数字,指定在 querySet 中用于写入渲染通道结束处时间戳的查询索引。此项是可选的 - 如果未定义,则不会为通道的结束处写入时间戳。

注意: 要使用时间戳查询,需要启用 timestamp-query 功能。时间戳查询值以纳秒为单位写入,但具体值的确定方式取决于具体实现。

返回值

一个 GPUComputePassEncoder 对象实例。

验证

调用 beginComputePass() 时必须满足以下条件,否则将生成 GPUValidationError 并返回一个无效的 GPUComputePassEncoder 对象。

  • GPUDevice 中启用了 timestamp-query 功能

示例

在我们的 基础计算演示 中,通过 GPUCommandEncoder 记录了多个命令。其中大多数命令都源自通过 beginComputePass() 创建的 GPUComputePassEncoder

js
// …

// Create GPUCommandEncoder to encode commands to issue to the GPU
const commandEncoder = device.createCommandEncoder();

// Initiate render pass
const passEncoder = commandEncoder.beginComputePass();

// Issue commands
passEncoder.setPipeline(computePipeline);
passEncoder.setBindGroup(0, bindGroup);
passEncoder.dispatchWorkgroups(Math.ceil(BUFFER_SIZE / 64));

// End the render pass
passEncoder.end();

// Copy output buffer to staging buffer
commandEncoder.copyBufferToBuffer(
  output,
  0, // Source offset
  stagingBuffer,
  0, // Destination offset
  BUFFER_SIZE,
);

// End frame by passing array of command buffers to command queue for execution
device.queue.submit([commandEncoder.finish()]);

// …

规范

规范
WebGPU
# dom-gpucommandencoder-begincomputepass

浏览器兼容性

另见