Phaser.Renderer.WebGL.WebGLStencilParametersFactory

Scope: static

Source: src/renderer/webgl/parameters/WebGLStencilParametersFactory.js#L7
Since: 4.0.0

Static functions

create

<instance> create(renderer, [enabled], [func], [funcRef], [funcMask], [opFail], [opZfail], [opZpass], [clear])

Description:

Creates a new WebGLStencilParameters object that encapsulates the full stencil buffer configuration for a WebGL render pass. The returned object groups the arguments into the three sub-objects expected by the renderer: func (passed to gl.stencilFunc), op (passed to gl.stencilOp), and clear (the value written when the stencil buffer is cleared). All parameters are optional and fall back to sensible no-op defaults so the stencil buffer behaves as if it were disabled.

Parameters:

name	type	optional	default	description
renderer	Phaser.Renderer.WebGL.WebGLRenderer	No		The WebGLRenderer to create the WebGLStencilParameters for.
enabled	GLboolean	Yes	false	Whether the stencil test is enabled.
func	GLenum	Yes	"GL_ALWAYS"	The stencil comparison function used to compare the reference value against the current stencil buffer value.
funcRef	GLint	Yes	0	The reference value against which the stencil buffer value is compared during the stencil test.
funcMask	GLuint	Yes	"0xFF"	The bitwise mask applied to both the reference value and the stencil buffer value before they are compared.
opFail	GLenum	Yes	"GL_KEEP"	The operation to perform if the stencil test fails.
opZfail	GLenum	Yes	"GL_KEEP"	The operation to perform if the stencil test passes but the depth test fails.
opZpass	GLenum	Yes	"GL_KEEP"	The operation to perform if the stencil test passes and the depth test passes or is disabled.
clear	GLint	Yes	0	The value to clear the stencil buffer to.

Returns: Phaser.Types.Renderer.WebGL.WebGLStencilParameters - The created WebGLStencilParameters.

Source: src/renderer/webgl/parameters/WebGLStencilParametersFactory.js#L19
Since: 4.0.0

---