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

瀏覽器相容性

另見