GPURenderPassEncoder: setStencilReference() method

{{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

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 ({{jsxref("Undefined")}}).

Examples

// …

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