GPURenderPassEncoder: endOcclusionQuery() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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
BCD tables only load in the browser
See also
- The WebGPU API