GPURenderPassEncoder: setStencilReference() Methode

Limited availability

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

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig, bevor Sie diese produktiv verwenden.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Die setStencilReference()-Methode der GPURenderPassEncoder Schnittstelle legt den Stencil-Referenzwert fest, der während Stencil-Tests mit der "replace"-Stencil-Operation verwendet wird (wie im Deskriptor der GPUDevice.createRenderPipeline() Methode festgelegt, in den Eigenschaften, die die verschiedenen Stencil-Operationen definieren).

Syntax

js
setStencilReference(reference)

Parameter

reference

Eine Zahl, die den neuen Stencil-Referenzwert darstellt, der für den Renderdurchgang festgelegt werden soll.

Hinweis: Wenn kein Aufruf von setStencilReference() erfolgt, wird der Stencil-Referenzwert standardmäßig auf 0 für jeden Renderdurchgang gesetzt.

Rückgabewert

Keiner (Undefined).

Beispiele

js
// ...

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

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

passEncoder.end();

// ...

Spezifikationen

Specification
WebGPU
# dom-gpurenderpassencoder-setstencilreference

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch