WebGLRenderingContext: stencilFunc()-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.stencilFunc()-Methode der WebGL API setzt die Funktion und den Referenzwert für den Stencil-Test sowohl für die Vorder- als auch für die Rückseite.
Das Stenciling ermöglicht das Zeichnen auf Pixelbasis ein- und auszuschalten. Es wird typischerweise im Mehrfachdurchlauf-Rendering verwendet, um spezielle Effekte zu erzielen.
Syntax
stencilFunc(func, ref, mask)
Parameter
func-
Ein
GLenum, das die Testfunktion angibt. Die Standardfunktion istgl.ALWAYS. Die möglichen Werte sind:gl.NEVER: Niemals bestehen.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, das den Referenzwert für den Stencil-Test angibt. Dieser Wert wird auf den Bereich 0 bis 2^n - 1 geklammert, wobei n die Anzahl der Bitplanes im Stencil-Puffer ist. Der Standardwert ist 0. mask-
Ein
GLuint, der eine bitweise Maske darstellt, die verwendet wird, um den Referenzwert und den gespeicherten Stencil-Wert während des Tests mit UND zu verknüpfen. 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.
gl.enable(gl.STENCIL_TEST);
gl.stencilFunc(gl.LESS, 0, 0b1110011);
Um die aktuelle Stencil-Funktion, den Referenzwert oder andere Stencil-Informationen abzurufen,
fragen Sie die folgenden Konstanten mit getParameter() ab.
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 |