MLNCustomStyleLayer + Metal example

platform/BUILD.bazel

@@ -11,11 +11,6 @@ objc_library(
         "//platform/ios:ios_public_hdrs",
         "//platform/ios:ios_sdk_hdrs",
     ] + select({
-        "//:metal_renderer": [],
-        "//conditions:default": [
-            "//platform/darwin:darwin_objcpp_opengl_srcs",
-        ],
-    }) + select({
         "//:legacy_renderer": [],
         "//conditions:default": [
             "//platform/darwin:darwin_objcpp_custom_drawable_srcs",
@@ -262,11 +257,6 @@ sh_binary(
         "//platform/macos:macos_private_hdrs",
         "//platform/macos:macos_public_hdrs",
     ] + select({
-        "//:metal_renderer": [],
-        "//conditions:default": [
-            "//platform/darwin:darwin_objcpp_opengl_srcs",
-        ],
-    }) + select({
         "//:legacy_renderer": [],
         "//conditions:default": [
             "//platform/darwin:darwin_objcpp_custom_drawable_srcs",

platform/darwin/BUILD.bazel

@@ -5,7 +5,6 @@ load(
     "MLN_DARWIN_OBJC_HEADERS",
     "MLN_DARWIN_PRIVATE_HEADERS",
     "MLN_DARWIN_PUBLIC_OBJCPP_CUSTOM_DRAWABLE_SOURCE",
-    "MLN_DARWIN_PUBLIC_OBJCPP_OPENGL_SOURCE",
     "MLN_DARWIN_PUBLIC_OBJCPP_SOURCE",
     "MLN_DARWIN_PUBLIC_OBJC_SOURCE",
     "MLN_GENERATED_DARWIN_STYLE_HEADERS",
@@ -42,12 +41,6 @@ filegroup(
     visibility = ["//visibility:public"],
 )
 
-filegroup(
-    name = "darwin_objcpp_opengl_srcs",
-    srcs = MLN_DARWIN_PUBLIC_OBJCPP_OPENGL_SOURCE,
-    visibility = ["//visibility:public"],
-)
-
 filegroup(
     name = "darwin_objcpp_custom_drawable_srcs",
     srcs = MLN_DARWIN_PUBLIC_OBJCPP_CUSTOM_DRAWABLE_SOURCE,
@@ -328,7 +321,6 @@ exports_files(
         "scripts/check-public-symbols.sh",
     ] + MLN_DARWIN_PUBLIC_OBJC_SOURCE +
     MLN_DARWIN_PUBLIC_OBJCPP_SOURCE +
-    MLN_DARWIN_PUBLIC_OBJCPP_OPENGL_SOURCE +
     MLN_DARWIN_PUBLIC_OBJCPP_CUSTOM_DRAWABLE_SOURCE +
     MLN_DARWIN_PRIVATE_HEADERS +
     MLN_DARWIN_OBJC_HEADERS +

platform/darwin/app/LimeGreenStyleLayer.h

@@ -1,5 +1,5 @@
 #import "Mapbox.h"
 
-@interface LimeGreenStyleLayer : MLNOpenGLStyleLayer
+@interface LimeGreenStyleLayer : MLNCustomStyleLayer
 
 @end

platform/darwin/bazel/files.bzl

@@ -58,6 +58,7 @@ MLN_DARWIN_OBJC_HEADERS = [
     "src/MLNCompassDirectionFormatter.h",
     "src/MLNComputedShapeSource.h",
     "src/MLNCoordinateFormatter.h",
+    "src/MLNCustomStyleLayer.h",
     "src/MLNDefaultStyle.h",
     "src/MLNDistanceFormatter.h",
     "src/MLNFeature.h",
@@ -124,6 +125,7 @@ MLN_DARWIN_OBJCPP_HEADERS = [
 MLN_DARWIN_PRIVATE_HEADERS = [
     "src/MLNAttributionInfo_Private.h",
     "src/MLNComputedShapeSource_Private.h",
+    "src/MLNCustomStyleLayer_Private.h",
     "src/MLNFeature_Private.h",
     "src/MLNFoundation_Private.h",
     "src/MLNGeometry_Private.h",
@@ -158,6 +160,7 @@ MLN_DARWIN_PRIVATE_HEADERS = [
 MLN_DARWIN_PUBLIC_OBJCPP_SOURCE = [
     "src/MLNAttributionInfo.mm",
     "src/MLNComputedShapeSource.mm",
+    "src/MLNCustomStyleLayer.mm",
     "src/MLNDefaultStyle.mm",
     "src/MLNFeature.mm",
     "src/MLNForegroundStyleLayer.mm",
@@ -203,11 +206,6 @@ MLN_DARWIN_PUBLIC_OBJCPP_SOURCE = [
     "src/NSPredicate+MLNAdditions.mm",
     "src/NSValue+MLNStyleAttributeAdditions.mm",
 ]
-MLN_DARWIN_PUBLIC_OBJCPP_OPENGL_SOURCE = [
-    "src/MLNOpenGLStyleLayer_Private.h",
-    "src/MLNOpenGLStyleLayer.h",
-    "src/MLNOpenGLStyleLayer.mm",
-]
 MLN_DARWIN_PUBLIC_OBJCPP_CUSTOM_DRAWABLE_SOURCE = [
     "src/MLNCustomDrawableStyleLayer_Private.h",
     "src/MLNCustomDrawableStyleLayer.h",

platform/darwin/src/MLNOpenGLStyleLayer.h → platform/darwin/src/MLNCustomStyleLayer.h

@@ -23,7 +23,7 @@ typedef struct MLNStyleLayerDrawingContext {
 } MLNStyleLayerDrawingContext;
 
 MLN_EXPORT
-@interface MLNOpenGLStyleLayer : MLNStyleLayer
+@interface MLNCustomStyleLayer : MLNStyleLayer
 
 @property (nonatomic, weak, readonly) MLNStyle *style;
 

platform/darwin/src/MLNOpenGLStyleLayer.mm → platform/darwin/src/MLNCustomStyleLayer.mm

@@ -1,5 +1,5 @@
-#import "MLNOpenGLStyleLayer.h"
-#import "MLNOpenGLStyleLayer_Private.h"
+#import "MLNCustomStyleLayer.h"
+#import "MLNCustomStyleLayer_Private.h"
 
 #import "MLNMapView_Private.h"
 #import "MLNStyle_Private.h"
@@ -12,7 +12,7 @@
 class MLNOpenGLLayerHost;
 
 /**
- An `MLNOpenGLStyleLayer` is a style layer that is rendered by OpenGL code that
+ An `MLNCustomStyleLayer` is a style layer that is rendered by OpenGL code that
  you provide.
 
  By default, this class does nothing. You can subclass this class to provide
@@ -29,7 +29,7 @@
  @warning This API is undocumented and therefore unsupported. It may change at
     any time without notice.
  */
-@interface MLNOpenGLStyleLayer ()
+@interface MLNCustomStyleLayer ()
 
 @property (nonatomic, readonly) mbgl::style::CustomLayer *rawLayer;
 
@@ -45,7 +45,7 @@ @interface MLNOpenGLStyleLayer ()
 
 @end
 
-@implementation MLNOpenGLStyleLayer
+@implementation MLNCustomStyleLayer
 
 /**
  Returns an OpenGL style layer object initialized with the given identifier.
@@ -166,7 +166,7 @@ - (void)setNeedsDisplay {
 
 class MLNOpenGLLayerHost : public mbgl::style::CustomLayerHost {
 public:
-    MLNOpenGLLayerHost(MLNOpenGLStyleLayer *styleLayer) {
+    MLNOpenGLLayerHost(MLNCustomStyleLayer *styleLayer) {
         layerRef = styleLayer;
         layer = nil;
     }
@@ -209,14 +209,14 @@ void deinitialize() {
         layer = nil;
     }
 private:
-    __weak MLNOpenGLStyleLayer * layerRef;
-    MLNOpenGLStyleLayer * layer = nil;
+    __weak MLNCustomStyleLayer * layerRef;
+    MLNCustomStyleLayer * layer = nil;
 };
 
 namespace mbgl {
 
 MLNStyleLayer* OpenGLStyleLayerPeerFactory::createPeer(style::Layer* rawLayer) {
-    return [[MLNOpenGLStyleLayer alloc] initWithRawLayer:rawLayer];
+    return [[MLNCustomStyleLayer alloc] initWithRawLayer:rawLayer];
 }
 
 }  // namespace mbgl

platform/darwin/src/MLNStyle.mm

@@ -40,7 +40,7 @@
 #import "NSDate+MLNAdditions.h"
 
 #if !MLN_RENDER_BACKEND_METAL
-    #import "MLNOpenGLStyleLayer.h"
+    #import "MLNCustomStyleLayer.h"
 #endif
 
 #if TARGET_OS_IPHONE
@@ -82,7 +82,7 @@ @interface MLNStyle()
 @property (nonatomic, readonly, weak) id <MLNStylable> stylable;
 @property (nonatomic, readonly) mbgl::style::Style *rawStyle;
 @property (readonly, copy, nullable) NSURL *URL;
-@property (nonatomic, readwrite, strong) NSMutableDictionary<NSString *, MLNOpenGLStyleLayer *> *openGLLayers;
+@property (nonatomic, readwrite, strong) NSMutableDictionary<NSString *, MLNCustomStyleLayer *> *openGLLayers;
 @property (nonatomic) NSMutableDictionary<NSString *, NSDictionary<NSObject *, MLNTextLanguage *> *> *localizedLayersByIdentifier;
 
 @end

platform/darwin/src/MLNStyleLayerManager.mm

@@ -11,7 +11,7 @@
 #import "MLNSymbolStyleLayer_Private.h"
 
 #if !MLN_RENDER_BACKEND_METAL
-#import "MLNOpenGLStyleLayer_Private.h"
+#import "MLNCustomStyleLayer_Private.h"
 #endif
 
 #if MLN_DRAWABLE_RENDERER

platform/darwin/src/MLNStyle_Private.h

@@ -13,7 +13,7 @@ namespace mbgl {
 
 @class MLNAttributionInfo;
 @class MLNMapView;
-@class MLNOpenGLStyleLayer;
+@class MLNCustomStyleLayer;
 @class MLNVectorTileSource;
 @class MLNVectorStyleLayer;
 
@@ -25,7 +25,7 @@ namespace mbgl {
 @property (nonatomic, readonly) mbgl::style::Style *rawStyle;
 
 - (nullable NSArray<MLNAttributionInfo *> *)attributionInfosWithFontSize:(CGFloat)fontSize linkColor:(nullable MLNColor *)linkColor;
-@property (nonatomic, readonly, strong) NSMutableDictionary<NSString *, MLNOpenGLStyleLayer *> *openGLLayers;
+@property (nonatomic, readonly, strong) NSMutableDictionary<NSString *, MLNCustomStyleLayer *> *openGLLayers;
 - (void)setStyleClasses:(NSArray<NSString *> *)appliedClasses transitionDuration:(NSTimeInterval)transitionDuration;
 
 @end

platform/darwin/test/MLNStyleTests.mm

@@ -233,7 +233,7 @@ - (void)testAddingLayersWithDuplicateIdentifiers {
     XCTAssertThrowsSpecificNamed([self.style insertLayer:[[MLNFillStyleLayer alloc] initWithIdentifier:@"my-layer" source:source] aboveLayer:initial], NSException, @"MLNRedundantLayerIdentifierException");
     XCTAssertThrowsSpecificNamed([self.style insertLayer:[[MLNFillStyleLayer alloc] initWithIdentifier:@"my-layer" source:source] atIndex:0], NSException, @"MLNRedundantLayerIdentifierException");
 #if !MLN_RENDER_BACKEND_METAL
-    XCTAssertThrowsSpecificNamed([self.style insertLayer:[[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"my-layer"] atIndex:0], NSException, @"MLNRedundantLayerIdentifierException");
+    XCTAssertThrowsSpecificNamed([self.style insertLayer:[[MLNCustomStyleLayer alloc] initWithIdentifier:@"my-layer"] atIndex:0], NSException, @"MLNRedundantLayerIdentifierException");
 #endif
 }
 

platform/ios/Integration_Tests/MBGLIntegrationTests.mm

@@ -17,7 +17,7 @@ - (void)waitForMapViewToBeRendered {
 
 // This test does not strictly need to be in this test file/target. Including here for convenience.
 - (void)testOpenGLLayerDoesNotLeakWhenCreatedAndDestroyedWithoutAddingToStyle {
-    MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+    MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
     __weak id weakLayer = layer;
     layer = nil;
 
@@ -31,7 +31,7 @@ - (void)testAddingRemovingOpenGLLayerWithoutRendering {
         __weak id weakLayer = nil;
 
         @autoreleasepool {
-            MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+            MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
             [self.style insertLayer:layer atIndex:0];
             weakLayer = layer;
 
@@ -49,15 +49,15 @@ - (void)testAddingRemovingOpenGLLayerWithoutRendering {
 }
 
 - (void)testReusingOpenGLLayerIdentifier {
-    __weak MLNOpenGLStyleLayer *weakLayer2;
+    __weak MLNCustomStyleLayer *weakLayer2;
 
     @autoreleasepool {
-        MLNOpenGLStyleLayer *layer1 = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+        MLNCustomStyleLayer *layer1 = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
         [self.style insertLayer:layer1 atIndex:0];
         [self waitForMapViewToBeRendered];
         [self.style removeLayer:layer1];
 
-        MLNOpenGLStyleLayer *layer2 = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+        MLNCustomStyleLayer *layer2 = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
         weakLayer2 = layer2;
 
         XCTAssertNotNil(layer2);
@@ -88,7 +88,7 @@ - (void)testAddingRemovingOpenGLLayer {
         __weak id retrievedLayer = nil;
 
         @autoreleasepool {
-            MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+            MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
             [self.style insertLayer:layer atIndex:0];
             layer = nil;
 
@@ -110,7 +110,7 @@ - (void)testAddingRemovingOpenGLLayer {
 }
 
 - (void)testReusingOpenGLLayer {
-    MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+    MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
     [self.style insertLayer:layer atIndex:0];
     [self waitForMapViewToBeRendered];
 
@@ -127,7 +127,7 @@ - (void)testReusingOpenGLLayer {
 - (void)testOpenGLLayerDoesNotLeakWhenRemovedFromStyle {
     __weak id weakLayer;
     @autoreleasepool {
-        MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+        MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
         weakLayer = layer;
         [self.style insertLayer:layer atIndex:0];
         layer = nil;
@@ -146,11 +146,11 @@ - (void)testOpenGLLayerDoesNotLeakWhenRemovedFromStyle {
 }
 
 - (void)testOpenGLLayerDoesNotLeakWhenStyleChanged {
-    __weak MLNOpenGLStyleLayer *weakLayer;
+    __weak MLNCustomStyleLayer *weakLayer;
 
     @autoreleasepool {
         {
-            MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+            MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
             weakLayer = layer;
             [self.style insertLayer:layer atIndex:0];
             layer = nil;
@@ -192,7 +192,7 @@ - (void)testOpenGLLayerDoesNotLeakWhenMapViewDeallocs {
         self.styleLoadingExpectation = [self expectationWithDescription:@"Map view should finish loading style."];
         [self waitForExpectationsWithTimeout:10 handler:nil];
 
-        MLNOpenGLStyleLayer *layer = [[MLNOpenGLStyleLayer alloc] initWithIdentifier:@"gl-layer"];
+        MLNCustomStyleLayer *layer = [[MLNCustomStyleLayer alloc] initWithIdentifier:@"gl-layer"];
         weakLayer = layer;
         [mapView2.style insertLayer:layer atIndex:0];
         layer = nil;

platform/ios/sdk-files.json

@@ -113,7 +113,7 @@
         "platform/darwin/src/MLNPointCollection.mm",
         "platform/darwin/src/MLNLineStyleLayer.mm",
         "platform/ios/src/MLNMapAccessibilityElement.mm",
-        "platform/darwin/src/MLNOpenGLStyleLayer.mm",
+        "platform/darwin/src/MLNCustomStyleLayer.mm",
         "platform/darwin/src/MLNSettings.mm",
         "platform/darwin/src/NSCompoundPredicate+MLNAdditions.mm",
         "platform/ios/src/MLNTelemetryConfig.m",
@@ -185,7 +185,7 @@
         "MLNOfflineRegion.h": "platform/darwin/src/MLNOfflineRegion.h",
         "MLNMapViewDelegate.h": "platform/ios/src/MLNMapViewDelegate.h",
         "MLNDistanceFormatter.h": "platform/darwin/src/MLNDistanceFormatter.h",
-        "MLNOpenGLStyleLayer.h": "platform/darwin/src/MLNOpenGLStyleLayer.h",
+        "MLNCustomStyleLayer.h": "platform/darwin/src/MLNCustomStyleLayer.h",
         "MLNTileSource.h": "platform/darwin/src/MLNTileSource.h",
         "MLNTilePyramidOfflineRegion.h": "platform/darwin/src/MLNTilePyramidOfflineRegion.h",
         "MLNVectorTileSource.h": "platform/darwin/src/MLNVectorTileSource.h",
@@ -277,7 +277,7 @@
         "MLNGeometry_Private.h": "platform/darwin/src/MLNGeometry_Private.h",
         "NSCompoundPredicate+MLNAdditions.h": "platform/darwin/src/NSCompoundPredicate+MLNAdditions.h",
         "NSExpression+MLNPrivateAdditions.h": "platform/darwin/src/NSExpression+MLNPrivateAdditions.h",
-        "MLNOpenGLStyleLayer_Private.h": "platform/darwin/src/MLNOpenGLStyleLayer_Private.h",
+        "MLNCustomStyleLayer_Private.h": "platform/darwin/src/MLNCustomStyleLayer_Private.h",
         "MLNTileSource_Private.h": "platform/darwin/src/MLNTileSource_Private.h",
         "MLNFaux3DUserLocationAnnotationView.h": "platform/ios/src/MLNFaux3DUserLocationAnnotationView.h",
         "MLNUserLocationAnnotationView_Private.h": "platform/ios/src/MLNUserLocationAnnotationView_Private.h",

platform/ios/src/Mapbox.template.h

@@ -46,9 +46,7 @@ FOUNDATION_EXPORT MLN_EXPORT const unsigned char MapboxVersionString[];
 #import "MLNOfflinePack.h"
 #import "MLNOfflineRegion.h"
 #import "MLNOfflineStorage.h"
-#if !MLN_RENDER_BACKEND_METAL
-#import "MLNOpenGLStyleLayer.h"
-#endif
+#import "MLNCustomStyleLayer.h"
 #import "MLNOverlay.h"
 #import "MLNPointAnnotation.h"
 #import "MLNPointCollection.h"

platform/macos/sdk-files.json

@@ -19,7 +19,7 @@
         "platform/macos/src/MLNAnnotationImage.m",
         "platform/darwin/src/NSExpression+MLNAdditions.mm",
         "platform/darwin/src/MLNFeature.mm",
-        "platform/darwin/src/MLNOpenGLStyleLayer.mm",
+        "platform/darwin/src/MLNCustomStyleLayer.mm",
         "platform/macos/src/NSColor+MLNAdditions.mm",
         "platform/macos/src/MLNAttributionButton.mm",
         "platform/darwin/src/MLNFillStyleLayer.mm",
@@ -108,7 +108,7 @@
         "MLNBackgroundStyleLayer.h": "platform/darwin/src/MLNBackgroundStyleLayer.h",
         "MLNPointCollection.h": "platform/darwin/src/MLNPointCollection.h",
         "MLNShape.h": "platform/darwin/src/MLNShape.h",
-        "MLNOpenGLStyleLayer.h": "platform/darwin/src/MLNOpenGLStyleLayer.h",
+        "MLNCustomStyleLayer.h": "platform/darwin/src/MLNCustomStyleLayer.h",
         "MLNSource.h": "platform/darwin/src/MLNSource.h",
         "MLNPolygon.h": "platform/darwin/src/MLNPolygon.h",
         "MLNClockDirectionFormatter.h": "platform/darwin/src/MLNClockDirectionFormatter.h",
@@ -202,7 +202,7 @@
         "NSDate+MLNAdditions.h": "platform/darwin/src/NSDate+MLNAdditions.h",
         "NSColor+MLNAdditions.h": "platform/macos/src/NSColor+MLNAdditions.h",
         "MLNMultiPoint_Private.h": "platform/darwin/src/MLNMultiPoint_Private.h",
-        "MLNOpenGLStyleLayer_Private.h": "platform/darwin/src/MLNOpenGLStyleLayer_Private.h",
+        "MLNCustomStyleLayer_Private.h": "platform/darwin/src/MLNCustomStyleLayer_Private.h",
         "MLNPolygon_Private.h": "platform/darwin/src/MLNPolygon_Private.h",
         "MLNShape_Private.h": "platform/darwin/src/MLNShape_Private.h",
         "MLNTilePyramidOfflineRegion_Private.h": "platform/darwin/src/MLNTilePyramidOfflineRegion_Private.h",

platform/macos/src/Mapbox.h

@@ -47,7 +47,7 @@ FOUNDATION_EXPORT MLN_EXPORT const unsigned char MapboxVersionString[];
 #import "MLNBackgroundStyleLayer.h"
 #import "MLNHeatmapStyleLayer.h"
 #import "MLNHillshadeStyleLayer.h"
-#import "MLNOpenGLStyleLayer.h"
+#import "MLNCustomStyleLayer.h"
 #import "MLNSource.h"
 #import "MLNTileSource.h"
 #import "MLNVectorTileSource.h"