Merge pull request #584 from openmobilemaps/feature/self-masking

Self Masking for Vector Layers
openmobilemaps · Feb 1, 2024 · df94302 · df94302
2 parents 0aebab2 + 0d43778
commit df94302
Show file tree

Hide file tree

Showing 46 changed files with 295 additions and 135 deletions.
diff --git a/android/src/main/cpp/graphics/objects/LineGroup2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/LineGroup2dOpenGl.cpp
@@ -109,11 +109,7 @@ void LineGroup2dOpenGl::render(const std::shared_ptr<::RenderingContextInterface
 
     std::shared_ptr<OpenGlContext> openGlContext = std::static_pointer_cast<OpenGlContext>(context);
     if (isMasked) {
-        if (isMaskInversed) {
-            glStencilFunc(GL_EQUAL, 0, 255);
-        } else {
-            glStencilFunc(GL_EQUAL, 128, 255);
-        }
+        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 255);
     } else {
         glEnable(GL_STENCIL_TEST);
         glStencilMask(0xFF);

diff --git a/android/src/main/cpp/graphics/objects/Polygon2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/Polygon2dOpenGl.cpp
@@ -104,14 +104,23 @@ void Polygon2dOpenGl::render(const std::shared_ptr<::RenderingContextInterface>
 
     std::shared_ptr<OpenGlContext> openGlContext = std::static_pointer_cast<OpenGlContext>(context);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        if (isMaskInversed) {
-            glStencilFunc(GL_EQUAL, 0, 255);
-        } else {
-            glStencilFunc(GL_EQUAL, 128, 255);
-        }
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
     }
-    glStencilOp(GL_KEEP, GL_KEEP, GL_INCR);
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
+    }
+
     glColorMask(GL_TRUE, GL_TRUE, GL_TRUE, GL_TRUE);
 
     drawPolygon(openGlContext, program, mvpMatrix);

diff --git a/android/src/main/cpp/graphics/objects/PolygonGroup2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/PolygonGroup2dOpenGl.cpp
@@ -98,9 +98,21 @@ void PolygonGroup2dOpenGl::render(const std::shared_ptr<::RenderingContextInterf
     if (!ready)
         return;
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     std::shared_ptr<OpenGlContext> openGlContext = std::static_pointer_cast<OpenGlContext>(context);

diff --git a/android/src/main/cpp/graphics/objects/PolygonPatternGroup2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/PolygonPatternGroup2dOpenGl.cpp
@@ -141,9 +141,21 @@ void PolygonPatternGroup2dOpenGl::render(const std::shared_ptr<::RenderingContex
 
     glUseProgram(program);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     prepareTextureDraw(program);

diff --git a/android/src/main/cpp/graphics/objects/Quad2dInstancedOpenGl.cpp b/android/src/main/cpp/graphics/objects/Quad2dInstancedOpenGl.cpp
@@ -206,9 +206,21 @@ void Quad2dInstancedOpenGl::render(const std::shared_ptr<::RenderingContextInter
 
     glUseProgram(program);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     if (usesTextureCoords) {

diff --git a/android/src/main/cpp/graphics/objects/Quad2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/Quad2dOpenGl.cpp
@@ -193,9 +193,21 @@ void Quad2dOpenGl::render(const std::shared_ptr<::RenderingContextInterface> &co
 
     glUseProgram(program);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     if (usesTextureCoords) {

diff --git a/android/src/main/cpp/graphics/objects/Quad2dStretchedInstancedOpenGl.cpp b/android/src/main/cpp/graphics/objects/Quad2dStretchedInstancedOpenGl.cpp
@@ -205,9 +205,21 @@ void Quad2dStretchedInstancedOpenGl::render(const std::shared_ptr<::RenderingCon
 
     glUseProgram(program);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     if (usesTextureCoords) {

diff --git a/android/src/main/cpp/graphics/objects/Text2dInstancedOpenGl.cpp b/android/src/main/cpp/graphics/objects/Text2dInstancedOpenGl.cpp
@@ -200,9 +200,21 @@ void Text2dInstancedOpenGl::render(const std::shared_ptr<::RenderingContextInter
 
     glUseProgram(program);
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     if (usesTextureCoords) {

diff --git a/android/src/main/cpp/graphics/objects/Text2dOpenGl.cpp b/android/src/main/cpp/graphics/objects/Text2dOpenGl.cpp
@@ -209,9 +209,21 @@ void Text2dOpenGl::render(const std::shared_ptr<::RenderingContextInterface> &co
         return;
     }
 
+    GLuint stencilMask = 0;
+    GLuint validTarget = 0;
+    GLenum zpass = GL_KEEP;
     if (isMasked) {
-        glStencilFunc(GL_EQUAL, isMaskInversed ? 0 : 128, 128);
-        glStencilOp(GL_KEEP, GL_KEEP, GL_KEEP);
+        stencilMask += 128;
+        validTarget = isMaskInversed ? 0 : 128;
+    }
+    if (renderPass.isPassMasked) {
+        stencilMask += 127;
+        zpass = GL_INCR;
+    }
+
+    if (stencilMask != 0) {
+        glStencilFunc(GL_EQUAL, validTarget, stencilMask);
+        glStencilOp(GL_KEEP, GL_KEEP, zpass);
     }
 
     glUseProgram(program);

diff --git a/bridging/android/java/io/openmobilemaps/mapscore/shared/graphics/RenderPassConfig.kt b/bridging/android/java/io/openmobilemaps/mapscore/shared/graphics/RenderPassConfig.kt
diff --git a/bridging/android/jni/graphics/NativeRenderPassConfig.cpp b/bridging/android/jni/graphics/NativeRenderPassConfig.cpp
diff --git a/bridging/android/jni/graphics/NativeRenderPassConfig.h b/bridging/android/jni/graphics/NativeRenderPassConfig.h
diff --git a/bridging/ios/MCRenderPassConfig+Private.mm b/bridging/ios/MCRenderPassConfig+Private.mm
diff --git a/bridging/ios/MCRenderPassConfig.h b/bridging/ios/MCRenderPassConfig.h
diff --git a/bridging/ios/MCRenderPassConfig.mm b/bridging/ios/MCRenderPassConfig.mm
diff --git a/djinni/graphics/core.djinni b/djinni/graphics/core.djinni
@@ -58,6 +58,7 @@ render_pass_interface = interface +c +j +o {
 
 render_pass_config = record {
     render_pass_index: i32;
+    is_pass_masked: bool;
 }
 
 renderer_interface = interface +c +j +o {

diff --git a/ios/graphics/Model/BaseGraphicsObject.swift b/ios/graphics/Model/BaseGraphicsObject.swift
@@ -78,4 +78,38 @@ extension BaseGraphicsObject: MCGraphicsObjectInterface {
                isMasked: isMasked,
                screenPixelAsRealMeterFactor: screenPixelAsRealMeterFactor)
     }
+
+    // MARK: - Stencil
+
+    func maskStencilState(readMask: UInt32 = 0b1111_1111, writeMask: UInt32 = 0b0000_0000) -> MTLDepthStencilState? {
+        let s = MTLStencilDescriptor()
+        s.stencilCompareFunction = .equal
+        s.stencilFailureOperation = .zero
+        s.depthFailureOperation = .keep
+        s.depthStencilPassOperation = .keep
+        s.readMask = readMask
+        s.writeMask = writeMask
+
+        let desc = MTLDepthStencilDescriptor()
+        desc.frontFaceStencil = s
+        desc.backFaceStencil = s
+
+        return device.makeDepthStencilState(descriptor: desc)
+    }
+
+    func renderPassMaskStencilState() -> MTLDepthStencilState? {
+        let s = MTLStencilDescriptor()
+        s.stencilCompareFunction = .equal
+        s.stencilFailureOperation = .keep
+        s.depthFailureOperation = .keep
+        s.depthStencilPassOperation = .incrementWrap
+        s.readMask = 0b1111_1111
+        s.writeMask = 0b0000_0001
+
+        let desc = MTLDepthStencilDescriptor()
+        desc.frontFaceStencil = s
+        desc.backFaceStencil = s
+
+        return device.makeDepthStencilState(descriptor: desc)
+    }
 }