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 vor der Verwendung auf produktiven Webseiten.

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

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die setStencilReference()-Methode der GPURenderPassEncoder-Schnittstelle setzt den Stencil-Referenzwert, der während der Stencil-Tests mit der Stencil-Operation "replace" verwendet wird (wie im Deskriptor der Methode GPUDevice.createRenderPipeline() 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 Renderdurchlauf festgelegt wird.

Hinweis: Wenn kein setStencilReference()-Aufruf erfolgt, wird der Stencil-Referenzwert für jeden Renderdurchlauf standardmäßig auf 0 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

Siehe auch