GPURenderPassEncoder:setStencilReference() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能在 Web Workers 中可用。

GPURenderPassEncoder 接口的 setStencilReference() 方法使用在模板测试期间的 "replace" 模板操作(如 GPUDevice.createRenderPipeline() 方法的描述符中设置,在定义各种模板操作的属性中)来设置模板参考值。

语法

js
setStencilReference(reference)

参数

reference

一个数字,表示要为渲染通道设置的新模板参考值。

注意: 如果没有调用 setStencilReference(),则每个渲染通道的模板参考值默认为 0。

返回值

无 (Undefined)。

示例

js
// …

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setStencilReference(1);
passEncoder.draw(3);

passEncoder.end();

// …

规范

规范
WebGPU
# dom-gpurenderpassencoder-setstencilreference

浏览器兼容性

另见