summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLBackgroundStyleLayer.h
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@users.noreply.github.com>2016-09-27 13:53:32 -0700
committerGitHub <noreply@github.com>2016-09-27 13:53:32 -0700
commita6aa786f35824922aee0d2baad94e4ce9f71e79c (patch)
tree4ca6fed37ec4d713b82c9f06da5f3d326e92bb0d /platform/darwin/src/MGLBackgroundStyleLayer.h
parent44c7e9d05edbe6fee9e8f98b91380b6c07e57ac7 (diff)
downloadqtlocation-mapboxgl-a6aa786f35824922aee0d2baad94e4ce9f71e79c.tar.gz
[ios, macos] flesh out iOS runtime styling docs (#6466)
- fixes #5959: MGLBaseStyleLayer docs - fixes #5960: MGLSource & subclasses docs - fixes #6467: concrete layer subclass docs - move Core Graphics include - slight code & template cleanups - add ./documentation to git ignores
Diffstat (limited to 'platform/darwin/src/MGLBackgroundStyleLayer.h')
-rw-r--r--platform/darwin/src/MGLBackgroundStyleLayer.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/platform/darwin/src/MGLBackgroundStyleLayer.h b/platform/darwin/src/MGLBackgroundStyleLayer.h
index a6eda28783..386b68feda 100644
--- a/platform/darwin/src/MGLBackgroundStyleLayer.h
+++ b/platform/darwin/src/MGLBackgroundStyleLayer.h
@@ -6,6 +6,12 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A map style's background layer is the bottommost layer and is used to style a color
+ or pattern to show below all other map features. You can query an `MGLMapView` for its
+ `style` and obtain the background layer using the `-[MGLStyle layerWithIdentifier:]`
+ method and passing `background` for the identifier.
+ */
@interface MGLBackgroundStyleLayer : MGLBaseStyleLayer <MGLStyleLayer>
- (instancetype)initWithLayerIdentifier:(NSString *)layerIdentifier;