GPURenderPassEncoder: setStencilReference() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 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
Specification |
---|
WebGPU # dom-gpurenderpassencoder-setstencilreference |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
setStencilReference |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- In development. Supported in a pre-release version.
- In development. Supported in a pre-release version.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- User must explicitly enable this feature.
- Has more compatibility info.
See also
- The WebGPU API