GPURenderPassEncoder: phương thức beginOcclusionQuery()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

Phương thức beginOcclusionQuery() của giao diện GPURenderPassEncoder bắt đầu một truy vấn occlusion tại chỉ mục được chỉ định của GPUQuerySet liên quan (được cung cấp làm giá trị của thuộc tính descriptor occlusionQuerySet khi gọi GPUCommandEncoder.beginRenderPass() để chạy lần thực thi kết xuất).

Cú pháp

js
beginOcclusionQuery(queryIndex)

Tham số

queryIndex

Chỉ mục trong GPUQuerySet để bắt đầu truy vấn occlusion tại đó.

Giá trị trả về

Không có (Undefined).

Xác thực

Các tiêu chí sau phải được đáp ứng khi gọi beginOcclusionQuery(), nếu không GPUValidationError sẽ được tạo ra và GPURenderPassEncoder sẽ không hợp lệ:

  • Một GPUQuerySet đã được chỉ định trong thuộc tính descriptor occlusionQuerySet khi gọi GPUCommandEncoder.beginRenderPass() nguồn gốc.
  • queryIndex nhỏ hơn GPUQuerySet.count.
  • queryIndex chưa được ghi vào trong cùng lần thực thi kết xuất.
  • Không có truy vấn occlusion nào đang hoạt động cho lần thực thi kết xuất này (tức là thông qua lệnh gọi beginOcclusionQuery() trước đó).

Ví dụ

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();

// …

Thông số kỹ thuật

Specification
WebGPU
# dom-gpurenderpassencoder-beginocclusionquery

Tương thích trình duyệt

Xem thêm