WebGLRenderingContext: stencilFunc() 方法

基线 广泛可用

此功能已完善，可在许多设备和浏览器版本上运行。它自以下日期起在各个浏览器中可用： 2015 年 7 月.

WebGLRenderingContext.stencilFunc() 方法是 WebGL API 的一部分，用于设置模板测试的前后函数和参考值。

模板化允许和禁用基于每个像素的绘制。它通常用于多通道渲染以实现特殊效果。

语法

js
stencilFunc(func, ref, mask)

参数

func

一个 GLenum，指定测试函数。默认函数为 gl.ALWAYS。可能的值为：

  • gl.NEVER：从不通过。
  • gl.LESS：如果 (ref & mask) < (stencil & mask) 则通过。
  • gl.EQUAL：如果 (ref & mask) = (stencil & mask) 则通过。
  • gl.LEQUAL：如果 (ref & mask) <= (stencil & mask) 则通过。
  • gl.GREATER：如果 (ref & mask) > (stencil & mask) 则通过。
  • gl.NOTEQUAL：如果 (ref & mask) !== (stencil & mask) 则通过。
  • gl.GEQUAL：如果 (ref & mask) >= (stencil & mask) 则通过。
  • gl.ALWAYS：始终通过。
ref

一个 GLint，指定模板测试的参考值。此值被限制在 0 到 2^n - 1 的范围内，其中 n 是模板缓冲区中位平面数。默认值为 0。

mask

一个 GLuint，指定一个按位掩码，用于在进行测试时对参考值和存储的模板值执行 AND 运算。默认值为全 1。

返回值

无 (undefined）。

示例

模板测试默认情况下处于禁用状态。要启用或禁用模板测试，请使用 enable() 和 disable() 方法，并传入参数 gl.STENCIL_TEST。

js
gl.enable(gl.STENCIL_TEST);
gl.stencilFunc(gl.LESS, 0, 0b1110011);

要获取当前的模板函数、参考值或其他模板信息，请使用 getParameter() 查询以下常量。

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

规范

规范
WebGL 规范
# 5.14.3

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

另请参阅