Support GL face culling

cmake/core-files.txt

@@ -59,6 +59,8 @@ src/mbgl/gl/color_mode.cpp
 src/mbgl/gl/color_mode.hpp
 src/mbgl/gl/context.cpp
 src/mbgl/gl/context.hpp
+src/mbgl/gl/cull_face_mode.cpp
+src/mbgl/gl/cull_face_mode.hpp
 src/mbgl/gl/debugging.cpp
 src/mbgl/gl/debugging.hpp
 src/mbgl/gl/debugging_extension.cpp

platform/node/test/ignores.json

@@ -76,6 +76,8 @@
   "render-tests/bright-v9/z0-wide": "https://github.com/mapbox/mapbox-gl-native/pull/12611",
   "render-tests/collator/resolved-locale": "Some test platforms don't resolve 'en' locale",
   "render-tests/collator/default": "Some test platforms don't resolve 'en' locale",
+  "render-tests/custom-layer-js/null-island": "Not implemented",
+  "render-tests/custom-layer-js/tent-3d": "Not implemented",
   "render-tests/debug/collision": "https://github.com/mapbox/mapbox-gl-native/issues/3841",
   "render-tests/debug/collision-lines": "https://github.com/mapbox/mapbox-gl-native/issues/10412",
   "render-tests/debug/collision-lines-overscaled": "https://github.com/mapbox/mapbox-gl-native/issues/10412",

src/mbgl/gl/context.cpp

@@ -617,6 +617,9 @@ void Context::setDirtyState() {
     clearDepth.setDirty();
     clearColor.setDirty();
     clearStencil.setDirty();
+    cullFace.setDirty();
+    cullFaceSide.setDirty();
+    frontFace.setDirty();
     program.setDirty();
     lineWidth.setDirty();
     activeTextureUnit.setDirty();
@@ -663,6 +666,16 @@ void Context::clear(optional<mbgl::Color> color,
     MBGL_CHECK_ERROR(glClear(mask));
 }
 
+void Context::setCullFaceMode(const CullFaceMode& mode) {
+    cullFace = mode.cullFace;
+
+    // These shouldn't need to be updated when face culling is disabled, but we
+    // might end up having the same isssues with Adreno 2xx GPUs as noted in
+    // Context::setDepthMode.
+    cullFaceSide = mode.side;
+    frontFace = mode.frontFace;
+}
+
 #if not MBGL_USE_GLES2
 void Context::setDrawMode(const Points& points) {
     pointSize = points.pointSize;

src/mbgl/gl/context.hpp

@@ -172,6 +172,7 @@ class Context {
     void setDepthMode(const DepthMode&);
     void setStencilMode(const StencilMode&);
     void setColorMode(const ColorMode&);
+    void setCullFaceMode(const CullFaceMode&);
 
     void draw(PrimitiveType,
               std::size_t indexOffset,
@@ -263,6 +264,9 @@ class Context {
     State<value::ClearStencil> clearStencil;
     State<value::LineWidth> lineWidth;
     State<value::BindRenderbuffer> bindRenderbuffer;
+    State<value::CullFace> cullFace;
+    State<value::CullFaceSide> cullFaceSide;
+    State<value::FrontFace> frontFace;
 #if not MBGL_USE_GLES2
     State<value::PointSize> pointSize;
 #endif // MBGL_USE_GLES2

src/mbgl/gl/cull_face_mode.cpp

@@ -0,0 +1,16 @@
+#include <mbgl/gl/cull_face_mode.hpp>
+#include <mbgl/gl/gl.hpp>
+#include <mbgl/util/traits.hpp>
+
+namespace mbgl {
+namespace gl {
+
+static_assert(underlying_type(CullFaceMode::Front) == GL_FRONT, "OpenGL enum mismatch");
+static_assert(underlying_type(CullFaceMode::Back) == GL_BACK, "OpenGL enum mismatch");
+static_assert(underlying_type(CullFaceMode::FrontAndBack) == GL_FRONT_AND_BACK, "OpenGL enum mismatch");
+
+static_assert(underlying_type(CullFaceMode::Clockwise) == GL_CW, "OpenGL enum mismatch");
+static_assert(underlying_type(CullFaceMode::CounterClockwise) == GL_CCW, "OpenGL enum mismatch");
+
+} // namespace gl
+} // namespace mbgl

src/mbgl/gl/cull_face_mode.hpp

@@ -0,0 +1,40 @@
+#pragma once
+
+#include <cstdint>
+
+namespace mbgl {
+namespace gl {
+
+class CullFaceMode {
+public:
+    enum CullFace : bool {
+        Disable = false,
+        Enable = true,
+    };
+
+    enum CullFaceSide : uint32_t {
+        Front = 0x0404,
+        Back = 0x0405,
+        FrontAndBack = 0x0408,
+    };
+
+    enum FrontFace : uint32_t {
+        Clockwise = 0x0900,
+        CounterClockwise = 0x0901
+    };
+
+    CullFace cullFace;
+    CullFaceSide side;
+    FrontFace frontFace;
+
+    static CullFaceMode disabled() {
+        return CullFaceMode { Disable, CullFaceSide::Back, FrontFace::CounterClockwise };
+    }
+
+    static CullFaceMode backCCW() {
+        return CullFaceMode { Enable, CullFaceSide::Back, FrontFace::CounterClockwise };
+    }
+};
+
+} // namespace gl
+} // namespace mbgl

src/mbgl/gl/program.hpp

@@ -118,6 +118,7 @@ class Program {
               DepthMode depthMode,
               StencilMode stencilMode,
               ColorMode colorMode,
+              CullFaceMode cullFaceMode,
               const UniformValues& uniformValues,
               VertexArray& vertexArray,
               const AttributeBindings& attributeBindings,
@@ -130,6 +131,7 @@ class Program {
         context.setDepthMode(depthMode);
         context.setStencilMode(stencilMode);
         context.setColorMode(colorMode);
+        context.setCullFaceMode(cullFaceMode);
 
         context.program = program;
 

src/mbgl/gl/value.cpp

@@ -303,6 +303,42 @@ BindRenderbuffer::Type BindRenderbuffer::Get() {
     return binding;
 }
 
+const constexpr CullFace::Type CullFace::Default;
+
+void CullFace::Set(const Type& value) {
+    MBGL_CHECK_ERROR(value == CullFaceMode::Enable ? glEnable(GL_CULL_FACE) : glDisable(GL_CULL_FACE));
+}
+
+CullFace::Type CullFace::Get() {
+    GLboolean cullFace;
+    MBGL_CHECK_ERROR(cullFace = glIsEnabled(GL_CULL_FACE));
+    return cullFace ? CullFaceMode::Enable : CullFaceMode::Disable;
+}
+
+const constexpr CullFaceSide::Type CullFaceSide::Default;
+
+void CullFaceSide::Set(const Type& value) {
+    MBGL_CHECK_ERROR(glCullFace(static_cast<GLenum>(value)));
+}
+
+CullFaceSide::Type CullFaceSide::Get() {
+    GLint cullFaceMode;
+    MBGL_CHECK_ERROR(glGetIntegerv(GL_CULL_FACE_MODE, &cullFaceMode));
+    return static_cast<Type>(cullFaceMode);
+}
+
+const constexpr FrontFace::Type FrontFace::Default;
+
+void FrontFace::Set(const Type& value) {
+    MBGL_CHECK_ERROR(glFrontFace(static_cast<GLenum>(value)));
+}
+
+FrontFace::Type FrontFace::Get() {
+    GLint frontFace;
+    MBGL_CHECK_ERROR(glGetIntegerv(GL_FRONT_FACE, &frontFace));
+    return static_cast<Type>(frontFace);
+}
+
 const constexpr BindTexture::Type BindTexture::Default;
 
 void BindTexture::Set(const Type& value) {

src/mbgl/gl/value.hpp

@@ -4,6 +4,7 @@
 #include <mbgl/gl/depth_mode.hpp>
 #include <mbgl/gl/stencil_mode.hpp>
 #include <mbgl/gl/color_mode.hpp>
+#include <mbgl/gl/cull_face_mode.hpp>
 #include <mbgl/gl/attribute.hpp>
 #include <mbgl/util/color.hpp>
 #include <mbgl/util/size.hpp>
@@ -212,6 +213,27 @@ struct BindRenderbuffer {
     static Type Get();
 };
 
+struct CullFace {
+    using Type = CullFaceMode::CullFace;
+    static const constexpr Type Default = CullFaceMode::Disable;
+    static void Set(const Type&);
+    static Type Get();
+};
+
+struct CullFaceSide {
+    using Type = CullFaceMode::CullFaceSide;
+    static const constexpr Type Default = CullFaceMode::Back;
+    static void Set(const Type&);
+    static Type Get();
+};
+
+struct FrontFace {
+    using Type = CullFaceMode::FrontFace;
+    static const constexpr Type Default = CullFaceMode::CounterClockwise;
+    static void Set(const Type&);
+    static Type Get();
+};
+
 struct BindTexture {
     using Type = gl::TextureID;
     static const constexpr Type Default = 0;

src/mbgl/programs/collision_box_program.hpp

@@ -61,6 +61,7 @@ class CollisionBoxProgram : public Program<
               gl::DepthMode depthMode,
               gl::StencilMode stencilMode,
               gl::ColorMode colorMode,
+              gl::CullFaceMode cullFaceMode,
               const UniformValues& uniformValues,
               const gl::VertexBuffer<CollisionBoxLayoutAttributes::Vertex>& layoutVertexBuffer,
               const gl::VertexBuffer<CollisionBoxDynamicAttributes::Vertex>& dynamicVertexBuffer,
@@ -92,6 +93,7 @@ class CollisionBoxProgram : public Program<
                     std::move(depthMode),
                     std::move(stencilMode),
                     std::move(colorMode),
+                    std::move(cullFaceMode),
                     allUniformValues,
                     vertexArrayIt->second,
                     Attributes::offsetBindings(allAttributeBindings, segment.vertexOffset),
@@ -140,6 +142,7 @@ class CollisionCircleProgram : public Program<
               gl::DepthMode depthMode,
               gl::StencilMode stencilMode,
               gl::ColorMode colorMode,
+              gl::CullFaceMode cullFaceMode,
               const UniformValues& uniformValues,
               const gl::VertexBuffer<CollisionBoxLayoutAttributes::Vertex>& layoutVertexBuffer,
               const gl::VertexBuffer<CollisionBoxDynamicAttributes::Vertex>& dynamicVertexBuffer,
@@ -169,6 +172,7 @@ class CollisionCircleProgram : public Program<
                     std::move(depthMode),
                     std::move(stencilMode),
                     std::move(colorMode),
+                    std::move(cullFaceMode),
                     allUniformValues,
                     vertexArrayIt->second,
                     Attributes::offsetBindings(allAttributeBindings, segment.vertexOffset),

src/mbgl/programs/program.hpp

@@ -73,6 +73,7 @@ class Program {
               gl::DepthMode depthMode,
               gl::StencilMode stencilMode,
               gl::ColorMode colorMode,
+              gl::CullFaceMode cullFaceMode,
               const gl::IndexBuffer<DrawMode>& indexBuffer,
               const SegmentVector<Attributes>& segments,
               const typename AllUniforms::Values& allUniformValues,
@@ -91,6 +92,7 @@ class Program {
                 std::move(depthMode),
                 std::move(stencilMode),
                 std::move(colorMode),
+                std::move(cullFaceMode),
                 allUniformValues,
                 vertexArrayIt->second,
                 Attributes::offsetBindings(allAttributeBindings, segment.vertexOffset),

src/mbgl/programs/symbol_program.hpp

@@ -311,6 +311,7 @@ class SymbolProgram {
               gl::DepthMode depthMode,
               gl::StencilMode stencilMode,
               gl::ColorMode colorMode,
+              gl::CullFaceMode cullFaceMode,
               const gl::IndexBuffer<DrawMode>& indexBuffer,
               const SegmentVector<Attributes>& segments,
               const typename AllUniforms::Values& allUniformValues,
@@ -329,6 +330,7 @@ class SymbolProgram {
                 std::move(depthMode),
                 std::move(stencilMode),
                 std::move(colorMode),
+                std::move(cullFaceMode),
                 allUniformValues,
                 vertexArrayIt->second,
                 Attributes::offsetBindings(allAttributeBindings, segment.vertexOffset),

src/mbgl/renderer/buckets/fill_extrusion_bucket.cpp

@@ -126,7 +126,12 @@ void FillExtrusionBucket::addFeature(const GeometryTileFeature& feature,
                     vertices.emplace_back(
                         FillExtrusionProgram::layoutVertex(p2, perp.x, perp.y, 0, 1, edgeDistance));
 
-                    triangles.emplace_back(triangleIndex, triangleIndex + 1, triangleIndex + 2);
+                    // ┌──────┐
+                    // │ 0  1 │ Counter-Clockwise winding order.
+                    // │      │ Triangle 1: 0 => 2 => 1
+                    // │ 2  3 │ Triangle 2: 1 => 2 => 3
+                    // └──────┘
+                    triangles.emplace_back(triangleIndex, triangleIndex + 2, triangleIndex + 1);
                     triangles.emplace_back(triangleIndex + 1, triangleIndex + 2, triangleIndex + 3);
                     triangleIndex += 4;
                     triangleSegment.vertexLength += 4;
@@ -141,8 +146,9 @@ void FillExtrusionBucket::addFeature(const GeometryTileFeature& feature,
         assert(nIndices % 3 == 0);
 
         for (uint32_t i = 0; i < nIndices; i += 3) {
-            triangles.emplace_back(flatIndices[indices[i]], flatIndices[indices[i + 1]],
-                                   flatIndices[indices[i + 2]]);
+            // Counter-Clockwise winding order.
+            triangles.emplace_back(flatIndices[indices[i]], flatIndices[indices[i + 2]],
+                                   flatIndices[indices[i + 1]]);
         }
 
         triangleSegment.vertexLength += totalVertices;

src/mbgl/renderer/layers/render_background_layer.cpp

@@ -76,6 +76,7 @@ void RenderBackgroundLayer::render(PaintParameters& parameters, RenderSource*) {
             parameters.depthModeForSublayer(0, gl::DepthMode::ReadOnly),
             gl::StencilMode::disabled(),
             parameters.colorModeForRenderPass(),
+            gl::CullFaceMode::disabled(),
             parameters.staticData.quadTriangleIndexBuffer,
             parameters.staticData.tileTriangleSegments,
             allUniformValues,

src/mbgl/renderer/layers/render_circle_layer.cpp

@@ -106,6 +106,7 @@ void RenderCircleLayer::render(PaintParameters& parameters, RenderSource*) {
                 ? parameters.stencilModeForClipping(tile.clip)
                 : gl::StencilMode::disabled(),
             parameters.colorModeForRenderPass(),
+            gl::CullFaceMode::disabled(),
             *bucket.indexBuffer,
             bucket.segments,
             allUniformValues,

src/mbgl/renderer/layers/render_custom_layer.cpp

@@ -65,6 +65,7 @@ void RenderCustomLayer::render(PaintParameters& paintParameters, RenderSource*)
     glContext.setDepthMode(paintParameters.depthModeForSublayer(0, gl::DepthMode::ReadOnly));
     glContext.setStencilMode(gl::StencilMode::disabled());
     glContext.setColorMode(paintParameters.colorModeForRenderPass());
+    glContext.setCullFaceMode(gl::CullFaceMode::disabled());
 
     CustomLayerRenderParameters parameters;
 

src/mbgl/renderer/layers/render_fill_extrusion_layer.cpp

@@ -109,6 +109,7 @@ void RenderFillExtrusionLayer::render(PaintParameters& parameters, RenderSource*
                 parameters.depthModeFor3D(gl::DepthMode::ReadWrite),
                 gl::StencilMode::disabled(),
                 parameters.colorModeForRenderPass(),
+                gl::CullFaceMode::backCCW(),
                 *tileBucket.indexBuffer,
                 tileBucket.triangleSegments,
                 allUniformValues,
@@ -209,6 +210,7 @@ void RenderFillExtrusionLayer::render(PaintParameters& parameters, RenderSource*
             gl::DepthMode::disabled(),
             gl::StencilMode::disabled(),
             parameters.colorModeForRenderPass(),
+            gl::CullFaceMode::disabled(),
             parameters.staticData.quadTriangleIndexBuffer,
             parameters.staticData.extrusionTextureSegments,
             allUniformValues,

src/mbgl/renderer/layers/render_fill_layer.cpp

@@ -119,6 +119,7 @@ void RenderFillLayer::render(PaintParameters& parameters, RenderSource*) {
                     depthMode,
                     parameters.stencilModeForClipping(tile.clip),
                     parameters.colorModeForRenderPass(),
+                    gl::CullFaceMode::disabled(),
                     indexBuffer,
                     segments,
                     allUniformValues,
@@ -208,6 +209,7 @@ void RenderFillLayer::render(PaintParameters& parameters, RenderSource*) {
                     depthMode,
                     parameters.stencilModeForClipping(tile.clip),
                     parameters.colorModeForRenderPass(),
+                    gl::CullFaceMode::disabled(),
                     indexBuffer,
                     segments,
                     allUniformValues,

src/mbgl/renderer/layers/render_heatmap_layer.cpp

@@ -127,6 +127,7 @@ void RenderHeatmapLayer::render(PaintParameters& parameters, RenderSource*) {
                 parameters.depthModeForSublayer(0, gl::DepthMode::ReadOnly),
                 stencilMode,
                 gl::ColorMode::additive(),
+                gl::CullFaceMode::disabled(),
                 *bucket.indexBuffer,
                 bucket.segments,
                 allUniformValues,
@@ -174,6 +175,7 @@ void RenderHeatmapLayer::render(PaintParameters& parameters, RenderSource*) {
             gl::DepthMode::disabled(),
             gl::StencilMode::disabled(),
             parameters.colorModeForRenderPass(),
+            gl::CullFaceMode::disabled(),
             parameters.staticData.quadTriangleIndexBuffer,
             parameters.staticData.extrusionTextureSegments,
             allUniformValues,

src/mbgl/renderer/layers/render_hillshade_layer.cpp

@@ -105,6 +105,7 @@ void RenderHillshadeLayer::render(PaintParameters& parameters, RenderSource* src
             parameters.depthModeForSublayer(0, gl::DepthMode::ReadOnly),
             gl::StencilMode::disabled(),
             parameters.colorModeForRenderPass(),
+            gl::CullFaceMode::disabled(),
             indexBuffer,
             segments,
             allUniformValues,
@@ -165,6 +166,7 @@ void RenderHillshadeLayer::render(PaintParameters& parameters, RenderSource* src
                 parameters.depthModeForSublayer(0, gl::DepthMode::ReadOnly),
                 gl::StencilMode::disabled(),
                 parameters.colorModeForRenderPass(),
+                gl::CullFaceMode::disabled(),
                 parameters.staticData.quadTriangleIndexBuffer,
                 parameters.staticData.rasterSegments,
                 allUniformValues,