GPURenderPassEncoder: setStencilReference() method

Limited availability

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

See full compatibility

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							server
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS	Deno
`setStencilReference`	Chrome – Partial support Chrome 113 (Release date: 2023-05-02) footnote Partial support footnote Supported on ChromeOS, macOS, and Windows. footnote Supported on Linux (Intel Gen12+ GPUs only) since Chrome 144.	Edge – Partial support Edge 113 (Release date: 2023-05-05) footnote Partial support footnote Supported on ChromeOS, macOS, and Windows. footnote Supported on Linux (Intel Gen12+ GPUs only) since Edge 144.	Firefox – Partial support Firefox 141 (Release date: 2025-07-22) footnote Partial support footnote Supports all contexts except service workers. See bug 1942431. footnote Supports Windows since Firefox 141. See bug 1972486. footnote Supports macOS Tahoe on Apple silicon since Firefox 145. See bug 1992212. footnote Supports older macOS versions on Apple silicon since Firefox 147. See bug 1993341. footnote Does not support macOS on Intel CPUs. See bug 2004105. footnote Does not support Linux. See bug 2006676.	Opera – Partial support Opera 99 (Release date: 2023-05-16) footnote Partial support footnote Supported on ChromeOS, macOS, and Windows. footnote Supported on Linux (Intel Gen12+ GPUs only) since Opera 128.	Safari – Full support Safari 26 (Release date: 2025-09-15) footnote Full support	Chrome Android – Full support Chrome Android 121 (Release date: 2024-01-23) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Full support Opera Android 81 (Release date: 2024-03-14) footnote Full support	Safari on iOS – Full support Safari on iOS 26 (Release date: 2025-09-15) footnote Full support	Samsung Internet – Full support Samsung Internet 25 (Release date: 2024-04-24) footnote Full support	WebView Android – Full support WebView Android 121 (Release date: 2024-01-23) footnote Full support	WebView on iOS – Full support WebView on iOS 26 (Release date: 2025-09-15) footnote Full support	Deno – No support Deno 1.8 – 1.31 (Release date: 2021-03-02) footnote Removed in 1.32 and later Deno – No support Deno 1.39 (Release date: 2023-12-14) disabled disabled From version 1.39 users must explicitly set the `--unstable-webgpu` runtime flag.

Tip: you can click/tap on a cell for more information.

Full support: Full support
Partial support: Partial support
No support: No support
: User must explicitly enable this feature.
: Has more compatibility info.