WebGPU API
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
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
// …
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setStencilReference(1);
passEncoder.draw(3);
passEncoder.end();
// …
Specifications
Browser compatibility
See also
- The WebGPU API
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
