GPURenderPassEncoder: setStencilReference() method
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The setStencilReference()
method of the
GPURenderPassEncoder
interface sets the stencil reference value using during stencil tests with the "replace"
stencil operation (as set in the descriptor of the GPUDevice.createRenderPipeline()
method, in the properties defining the various stencil operations).
Syntax
js
setStencilReference(reference)
Parameters
reference
-
A number representing the new stencil reference value to set for the render pass.
Note: If a setStencilReference()
call is not made, the stencil reference value defaults to 0 for each render pass.
Return value
None (Undefined
).
Examples
js
// ...
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setStencilReference(1);
passEncoder.draw(3);
passEncoder.end();
// ...
Specifications
Specification |
---|
WebGPU # dom-gpurenderpassencoder-setstencilreference |
Browser compatibility
BCD tables only load in the browser
See also
- The WebGPU API