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).
js
setStencilReference(reference)
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.
None (Undefined).
js
// ...
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setStencilReference(1);
passEncoder.draw(3);
passEncoder.end();
// ...
| Specification |
|---|
| WebGPU # dom-gpurenderpassencoder-setstencilreference |
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
setStencilReference |
113Currently supported on ChromeOS, macOS, and Windows only. |
113Currently supported on ChromeOS, macOS, and Windows only. |
previewCurrently supported on Linux and Windows only. |
No |
99Currently supported on ChromeOS, macOS, and Windows only. |
No | No | No | No | No | No | No |
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/GPURenderPassEncoder/setStencilReference