GPUDevice: createRenderBundleEncoder() 方法

可用性有限

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

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

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

createRenderBundleEncoder() 方法是 GPUDevice 接口的一个方法,用于创建一个 GPURenderBundleEncoder,它可用于预先记录命令束。这些命令束可以通过 GPURenderPassEncoderexecuteBundles() 方法,根据需要重复使用任意多次。

语法

js
createRenderBundleEncoder(descriptor)

参数

描述符(descriptor)

包含以下属性的对象:

colorFormats

一个枚举值数组,指定渲染目标的预期颜色格式。可能的值请参阅规范中 GPUTextureFormat 定义

depthReadOnly 可选

一个布尔值。如果为 true,则指定执行由 GPURenderBundleEncoder 创建的任何 GPURenderBundle 时,不会修改 depthStencilFormat 的深度分量。如果省略,depthReadOnly 默认为 false

depthStencilFormat 可选

一个枚举值,指定渲染目标的预期深度或模板格式。可能的值请参阅规范中 深度-模板格式 部分。

label 可选

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

sampleCount 可选

一个数字,表示渲染目标的预期采样计数。

stencilReadOnly 可选

一个布尔值。如果为 true,则指定执行由 GPURenderBundleEncoder 创建的任何 GPURenderBundle 时,不会修改 depthStencilFormat 的模板分量。如果省略,stencilReadOnly 默认为 false

返回值

一个 GPURenderBundleEncoder 对象实例。

示例

在 WebGPU Samples 的 Animometer 示例中,许多相似的操作同时应用于许多不同的对象。命令束是使用以下函数进行编码的:

js
function recordRenderPass(
  passEncoder: GPURenderBundleEncoder | GPURenderPassEncoder
) {
  if (settings.dynamicOffsets) {
    passEncoder.setPipeline(dynamicPipeline);
  } else {
    passEncoder.setPipeline(pipeline);
  }
  passEncoder.setVertexBuffer(0, vertexBuffer);
  passEncoder.setBindGroup(0, timeBindGroup);
  const dynamicOffsets = [0];
  for (let i = 0; i < numTriangles; ++i) {
    if (settings.dynamicOffsets) {
      dynamicOffsets[0] = i * alignedUniformBytes;
      passEncoder.setBindGroup(1, dynamicBindGroup, dynamicOffsets);
    } else {
      passEncoder.setBindGroup(1, bindGroups[i]);
    }
    passEncoder.draw(3, 1, 0, 0);
  }
}

稍后,使用 createRenderBundleEncoder() 创建一个 GPURenderBundleEncoder,调用该函数,然后使用 GPURenderBundleEncoder.finish() 将命令束记录到 GPURenderBundle 中。

js
const renderBundleEncoder = device.createRenderBundleEncoder({
  colorFormats: [presentationFormat],
});
recordRenderPass(renderBundleEncoder);
const renderBundle = renderBundleEncoder.finish();

然后使用 GPURenderPassEncoder.executeBundles() 在多个渲染通道中重用该工作以提高性能。请参阅示例代码列表以获取完整上下文。

js
// …

return function doDraw(timestamp) {
  if (startTime === undefined) {
    startTime = timestamp;
  }
  uniformTime[0] = (timestamp - startTime) / 1000;
  device.queue.writeBuffer(uniformBuffer, timeOffset, uniformTime.buffer);

  renderPassDescriptor.colorAttachments[0].view = context
    .getCurrentTexture()
    .createView();

  const commandEncoder = device.createCommandEncoder();
  const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

  if (settings.renderBundles) {
    passEncoder.executeBundles([renderBundle]);
  } else {
    recordRenderPass(passEncoder);
  }

  passEncoder.end();
  device.queue.submit([commandEncoder.finish()]);
};

// …

规范

规范
WebGPU
# dom-gpudevice-createrenderbundleencoder

浏览器兼容性

另见