GPURenderPassEncoder: setStencilReference() 方法

实验性： 这是一项实验性技术
在生产环境中使用此方法之前，请仔细查看浏览器兼容性表。

安全上下文：此功能仅在安全上下文（HTTPS）中可用，在某些或所有支持的浏览器中可用。

setStencilReference() 方法是 GPURenderPassEncoder 接口的方法，它在使用“替换”模板操作（如在 GPUDevice.createRenderPipeline() 方法的描述符中设置，在定义各种模板操作的属性中）进行模板测试时设置模板引用值。

语法

setStencilReference(reference)

参数

reference: 表示要为渲染通道设置的新模板引用值的数字。

注意：如果未进行 setStencilReference() 调用，则每个渲染通道的模板引用值默认为 0。

返回值

无 (Undefined).

示例

// ...

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

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

passEncoder.end();

// ...

规范

规范
WebGPU # dom-gpurenderpassencoder-setstencilreference

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅

WebGPU API