GPURenderPassEncoder: setStencilReference() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

Note: This feature is available inWeb Workers.

ThesetStencilReference() method of theGPURenderPassEncoder interface sets the stencil reference value using during stencil tests with the"replace" stencil operation (as set in the descriptor of theGPUDevice.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 asetStencilReference() 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();// …