Correct stencil mask modes

mapbox · Dec 12, 2017 · 5560506 · 5560506
1 parent aa18375
commit 5560506
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 9 deletions.
diff --git a/src/gl/context.js b/src/gl/context.js
@@ -213,7 +213,11 @@ class Context {
             this.stencilTest.set(true);
             this.stencilMask.set(stencilMode.mask);
             this.stencilOp.set([stencilMode.fail, stencilMode.depthFail, stencilMode.pass]);
-            this.stencilFunc.set(util.pick(stencilMode, ['func', 'ref', 'mask']));
+            this.stencilFunc.set({
+                func: stencilMode.test.func,
+                ref: stencilMode.ref,
+                mask: stencilMode.test.mask
+            });
         }
     }
 

diff --git a/src/gl/stencil_mode.js b/src/gl/stencil_mode.js
@@ -1,20 +1,20 @@
 // @flow
-import type { CompareFuncType, StencilOpConstant } from './types';
+import type { StencilOpConstant, StencilTest } from './types';
 
 const ALWAYS = 0x0207;
 const KEEP = 0x1E00;
 
 class StencilMode {
-    func: CompareFuncType;
+    test: StencilTest;
     ref: number;
     mask: number;
     fail: StencilOpConstant;
     depthFail: StencilOpConstant;
     pass: StencilOpConstant;
 
-    constructor(func: CompareFuncType, ref: number, mask: number, fail: StencilOpConstant,
+    constructor(test: StencilTest, ref: number, mask: number, fail: StencilOpConstant,
         depthFail: StencilOpConstant, pass: StencilOpConstant) {
-        this.func = func;
+        this.test = test;
         this.ref = ref;
         this.mask = mask;
         this.fail = fail;
@@ -23,7 +23,7 @@ class StencilMode {
     }
 
     static disabled() {
-        return new StencilMode(ALWAYS, 0, 0, KEEP, KEEP, KEEP);
+        return new StencilMode({ func: ALWAYS, mask: 0 }, 0, 0, KEEP, KEEP, KEEP);
     }
 }
 

diff --git a/src/gl/types.js b/src/gl/types.js
@@ -58,3 +58,13 @@ export type StencilOpType = [StencilOpConstant, StencilOpConstant, StencilOpCons
 export type TextureUnitType = number;
 
 export type ViewportType = [number, number, number, number];
+
+export type StencilTest =
+    | { func: $PropertyType<WebGLRenderingContext, 'NEVER'>, mask: 0 }
+    | { func: $PropertyType<WebGLRenderingContext, 'LESS'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'EQUAL'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'LEQUAL'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'GREATER'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'NOTEQUAL'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'GEQUAL'>, mask: number }
+    | { func: $PropertyType<WebGLRenderingContext, 'ALWAYS'>, mask: 0 };
diff --git a/src/render/painter.js b/src/render/painter.js
@@ -191,7 +191,7 @@ class Painter {
 
         context.setColorMode(ColorMode.disabled());
         context.setDepthMode(DepthMode.disabled());
-        context.setStencilMode(new StencilMode(gl.ALWAYS, 0x0, 0xFF, gl.ZERO, gl.ZERO, gl.ZERO));
+        context.setStencilMode(new StencilMode({ func: gl.ALWAYS, mask: 0 }, 0x0, 0xFF, gl.ZERO, gl.ZERO, gl.ZERO));
 
         const matrix = mat4.create();
         mat4.ortho(matrix, 0, this.width, this.height, 0, 0, 1);
@@ -219,7 +219,7 @@ class Painter {
             const id = this._tileClippingMaskIDs[tileID.key] = idNext++;
 
             // Tests will always pass, and ref value will be written to stencil buffer.
-            context.setStencilMode(new StencilMode(gl.ALWAYS, id, 0xFF, gl.KEEP, gl.KEEP, gl.REPLACE));
+            context.setStencilMode(new StencilMode({ func: gl.ALWAYS, mask: 0 }, id, 0xFF, gl.KEEP, gl.KEEP, gl.REPLACE));
 
             const program = this.useProgram('fill', programConfiguration);
             gl.uniformMatrix4fv(program.uniforms.u_matrix, false, tileID.posMatrix);
@@ -232,7 +232,7 @@ class Painter {
 
     stencilModeForClipping(tileID: OverscaledTileID): StencilMode {
         const gl = this.context.gl;
-        return new StencilMode(gl.EQUAL, this._tileClippingMaskIDs[tileID.key], 0xFF, gl.KEEP, gl.KEEP, gl.REPLACE);
+        return new StencilMode({ func: gl.EQUAL, mask: 0xFF }, this._tileClippingMaskIDs[tileID.key], 0x00, gl.KEEP, gl.KEEP, gl.REPLACE);
     }
 
     colorModeForRenderPass(): ColorMode {