GPURenderPassEncoder: endOcclusionQuery() method
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.
The endOcclusionQuery() method of the GPURenderPassEncoder interface ends an active occlusion query previously started with beginOcclusionQuery().
Syntax
js
endOcclusionQuery() Parameters
None.
Return value
None (Undefined).
Validation
The following criteria must be met when calling endOcclusionQuery(), otherwise a GPUValidationError is generated and the GPURenderPassEncoder becomes invalid:
- An occlusion query is active for this render pass (i.e., via a previous
beginOcclusionQuery()call).
Examples
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(); // … Specifications
| Specification |
|---|
| WebGPU # dom-gpurenderpassencoder-endocclusionquery |
Browser compatibility
See also
- The WebGPU API