WebGLRenderingContext: stencilFuncSeparate() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

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

Die WebGLRenderingContext.stencilFuncSeparate() Methode des WebGL API setzt die Vorder- und/oder Rückseitenfunktion sowie den Referenzwert für den Stencil-Test.

Das Stenciln ermöglicht das Ein- und Ausschalten des Zeichnens auf Pixelbasis. Es wird typischerweise beim Multipass-Rendering verwendet, um spezielle Effekte zu erzielen.

Syntax

js
stencilFuncSeparate(face, func, ref, mask)

Parameter

face

Ein GLenum, das angibt, ob der Stencil-Zustand der Vorder- und/oder Rückseite aktualisiert wird. Die möglichen Werte sind:

  • gl.FRONT
  • gl.BACK
  • gl.FRONT_AND_BACK
func

Ein GLenum, das die Testfunktion angibt. Die Standardfunktion ist gl.ALWAYS. Die möglichen Werte sind:

  • gl.NEVER: Nie passieren.
  • gl.LESS: Bestehen, wenn (ref & mask) < (stencil & mask).
  • gl.EQUAL: Bestehen, wenn (ref & mask) = (stencil & mask).
  • gl.LEQUAL: Bestehen, wenn (ref & mask) <= (stencil & mask).
  • gl.GREATER: Bestehen, wenn (ref & mask) > (stencil & mask).
  • gl.NOTEQUAL: Bestehen, wenn (ref & mask) !== (stencil & mask).
  • gl.GEQUAL: Bestehen, wenn (ref & mask) >= (stencil & mask).
  • gl.ALWAYS: Immer bestehen.
ref

Ein GLint, der den Referenzwert für den Stencil-Test angibt. Dieser Wert wird auf den Bereich 0 bis 2^n - 1 geklemmt, wobei n die Anzahl der Bit-Ebenen im Stencil-Puffer ist. Der Standardwert ist 0.

mask

Ein GLuint, der eine bitweise Maske angibt, die verwendet wird, um den Referenzwert und den gespeicherten Stencil-Wert beim Testen zu maskieren. Der Standardwert ist alles 1.

Rückgabewert

Keiner (undefined).

Beispiele

Der Stencil-Test ist standardmäßig deaktiviert. Um den Stencil-Test zu aktivieren oder zu deaktivieren, verwenden Sie die Methoden enable() und disable() mit dem Argument gl.STENCIL_TEST.

js
gl.enable(gl.STENCIL_TEST);
gl.stencilFuncSeparate(gl.FRONT, gl.LESS, 0.2, 1110011);

Um die aktuelle Stencil-Funktion, den Referenzwert oder andere Stencil-Informationen zu erhalten, fragen Sie die folgenden Konstanten mit getParameter() ab.

js
gl.getParameter(gl.STENCIL_FUNC);
gl.getParameter(gl.STENCIL_VALUE_MASK);
gl.getParameter(gl.STENCIL_REF);
gl.getParameter(gl.STENCIL_BACK_FUNC);
gl.getParameter(gl.STENCIL_BACK_VALUE_MASK);
gl.getParameter(gl.STENCIL_BACK_REF);
gl.getParameter(gl.STENCIL_BITS);

Spezifikationen

Specification
WebGL Specification
# 5.14.3

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
stencilFuncSeparate

Legend

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

Full support
Full support

Siehe auch