GPURenderPassEncoder: setStencilReference() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **setStencilReference()** method of the {{domxref("GPURenderPassEncoder")}} interface sets the stencil reference value using during stencil tests with the "replace" stencil operation (as set in the descriptor of the {{domxref("GPUDevice.createRenderPipeline()")}} method, in the properties defining the various stencil operations).
Syntax
js-nolint
setStencilReference(reference)Parameters
reference- : A number representing the new stencil reference value to set for the render pass.
توجه: If a setStencilReference() call is not made, the stencil reference value defaults to 0 for each render pass.
Return value
None ({{jsxref("undefined")}}).
Examples
js
// …
const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setStencilReference(1);
passEncoder.draw(3);
passEncoder.end();
// …Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API