W3cubDocs

/Web APIs

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

	Desktop					Mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet	WebView Android	WebView on iOS
`setStencilReference`	113 Currently supported on ChromeOS, macOS, and Windows only.	113 Currently supported on ChromeOS, macOS, and Windows only.	141 Currently supported on Windows only, in all contexts except for service workers.	99 Currently supported on ChromeOS, macOS, and Windows only.	26	121	No	81	26	25.0	121	26