GPURenderPassEncoder: beginOcclusionQuery() 方法

可用性有限

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

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

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

GPURenderPassEncoder 接口的 beginOcclusionQuery() 方法会在相关的 GPUQuerySet 的指定索引处开始一个遮挡查询(该 GPUQuerySet 是在调用 GPUCommandEncoder.beginRenderPass() 来运行渲染通道时,作为 occlusionQuerySet 描述符属性的值提供的)。

语法

js
beginOcclusionQuery(queryIndex)

参数

queryIndex

GPUQuerySet 中开始遮挡查询的索引。

返回值

无 (Undefined)。

验证

调用 beginOcclusionQuery() 时必须满足以下条件,否则将生成 GPUValidationError,并且 GPURenderPassEncoder 会失效。

  • 在调用源 GPUCommandEncoder.beginRenderPass() 时,已在 occlusionQuerySet 描述符属性中指定了一个 GPUQuerySet
  • queryIndex 小于 GPUQuerySet.count
  • 在同一个渲染通道中,queryIndex 尚未被写入过。
  • 此渲染通道尚未激活遮挡查询(即,之前没有调用过 beginOcclusionQuery())。

示例

js
// …

// Create a query set to hold the occlusion queries
const querySet = device.createQuerySet({
  type: "occlusion",
  count: 32,
});

// Render pass descriptor object, including the querySet
const renderPassDescriptor = {
  colorAttachments: [
    {
      clearValue: clearColor,
      loadOp: "clear",
      storeOp: "store",
      view: context.getCurrentTexture().createView(),
    },
  ],
  occlusionQuerySet: querySet,
};

// Begin the render pass
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

// Begin an occlusion query at index 0
passEncoder.beginOcclusionQuery(0);

// Run some rendering commands
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);

// End the occlusion query
passEncoder.endOcclusionQuery();

// …

规范

规范
WebGPU
# dom-gpurenderpassencoder-beginocclusionquery

浏览器兼容性

另见