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 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

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
setStencilReference
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.
User must explicitly enable this feature.
Has more compatibility info.

Siehe auch