CHANGELOG.md

Changelog

main

✨ New features

• ...Add new stuff here...
• [core] Added new map observer events: onPreCompileShader, onPostCompileShader, onShaderCompileFailed, onGlyphsLoaded, onGlyphsError, onGlyphsRequested, onTileAction, onSpriteLoaded, onSpriteError, onSpriteRequested (#2694).
• [core] Add WebP image decoding support to default platform (Linux, Windows)
• [core] All CMake properties are now prefixed MLN_* 1054.
• [windows] Added windows build support for core applications and node #707
• [core] Add ClientOptions to configure client information #365.
• [node] Add workflow to create node binary releases for Ubuntu 20.04 x64 and MacOS 12 x64/arm64 #378, #459.

✨ Technical Improvements

• ...Add new stuff here...
• Bump maplibre-native-base from 2.0.0 to 2.1.1 (#397, #406)
• Bump wagyu from 0.4.3 to 0.5.0 #398
• Bump eternal from 1.0.0 to 1.0.1
• Bump protozero from 1.7.0 to 1.7.1
• Bump vector-tile from 1.0.3 to 1.0.4
• Bump polylabel from 1.0.3 to 1.1.0
• Bump googletest from 1.10.0 to 1.12.1
• Bump zip-archive from 2.2.3 to 2.5.2
• Bump cpp-httplib from this commit (~0.5.1) to 0.11.1

🐞 Bug fixes

• ...Add new stuff here...
• [core] Fix memory access violation exception in vector_tile_data.cpp #632
• [iOS] Fix a bug where the compass was determined to be misplaced when hidden #498.
• [core] MaptilerFileSource renamed to MBTilesFileSource #198.

maps-v1.6.0

✨ New features

• [core] Add support for Polygon, MultiPolygon geometry types in distance expression. (#16446)

• [core] Introduce a new API for controlling the camera ([#16419]mapbox/mapbox-gl-native#16419)

  Functions Map::getFreeCameraOptions() and Map::setFreeCameraOptions(options) provides an alternative way of accessing and modifying properties of the underlying camera entity. The API allows the user to treat the camera as a more traditional 3D object by modifying its position and orientation directly as opposed to setting the state implicitly by using CameraOptions. Both APIs are fully compatible with each other.

🐞 Bug fixes

• [core][tile mode] Labels priority fixes (#16432)

  This change does the following:

  • strictly arranges all the intersecting labels accordingly to the style-defined priorities
  • fixes placement order of the variable labels. Before this change, all variable labels that could potentially intersect tile borders were placed first, breaking the style label placement priority order. Now, all the variable labels, which do not actually intersect the tile borders, are placed accordingly to the style-defined priorities

maps-v1.6.0-rc.2

✨ New features

• [core] Introduce Source::setMinimumTileUpdateInterval API (#16416)

  The Source::setMinimumTileUpdateInterval(Duration) method sets the minimum tile update interval, which is used to throttle the tile update network requests.

  The corresponding Source::getMinimumTileUpdateInterval() getter is added too.

  Default minimum tile update interval value is Duration::zero().

• [core] Indroduce distance expression. (#16397)

  The distance expression returns the shortest distance between two geometries. The returned value can be consumed as an input into another expression for changing a paint or layout property or filtering features by distance.

  Currently, the distance expression supports Point, MultiPoint, LineString, MultiLineString geometry types.

• [core] Introduce style::Source::setVolatile()/isVolatile() API (#16422)

  The Source::setVolatile(bool) method sets a flag defining whether or not the fetched tiles for the given source should be stored in the local cache.

  The corresponding Source::isVolatile() getter is added too.

  By default, the source is not volatile.

• [ios, macos] Allow specifying multiple fonts or font families for local font rendering (#16253)

  By default, CJK characters are now set in the font specified by the text-font layout property. If the named font is not installed on the device or bundled with the application, the characters are set in one of the fallback fonts passed into the localFontFamily parameter of mbgl::Renderer::Renderer() and mbgl::MapSnapshotter::MapSnapshotter(). This parameter can now contain a list of font family names, font display names, and font PostScript names, each name separated by a newline.

🐞 Bug fixes

• [ios, macos] Fixed error receiving local file URL response (#16428)

• [ios, macos] Corrected metrics of locally rendered fonts (#16253)

  CJK characters are now laid out according to the font, so fonts with nonsquare glyphs have the correct kerning. This also fixes an issue where the baseline for CJK characters was too low compared to non-CJK characters.

maps-v1.6.0-rc.1

✨ New features

• [core] Move logging off the main thread (#16325)

• Add source property to limit parent's tile overscale factor (#16347)

  The new property sets a limit for how much parent tile can be overscaled.

• [core][tile mode] Introduce API to collect placed symbols data (#16339)

  The following methods are added to the Renderer class in implemented in the Tile map mode:

  • collectPlacedSymbolData() enables or disables collecting of the placed symbols data

  • getPlacedSymbolsData() if collecting of the placed symbols data is enabled, returns the reference to the PlacedSymbolData vector holding the collected data.

• [core] Enable circle-sort-key property (#15875)

  Adds support for circle-sort-key property, consistent with symbol-sort-key.

  Sorts drawing order by sort key both within-tile and cross-tile.

• [core] Add LocationIndicator layer (#16340)

  Adds a new layer type, location-indicator, that can be used to add a source-less indicator to the map, comprising raster images and a precision radius in meters.

• Add generic setter for Layer's 'source' property (#16406)

🐞 Bug fixes

• [core][tile mode] Reduce cut-off labels (part 2) (#16369)

  Now, the intersecting symbols are placed across all layers symbol by symbol according to the following rules:

  1. First we look, which of the tile border(s) the symbol intersects and prioritize the the symbol placement accordingly (high priority -> low priority): vertical & horizontal -> vertical -> horizontal
  2. For the symbols that intersect the same tile border(s), assuming the tile border split symbol into several sections, we look at the minimal section length. The symbol with a larger minimal section length is placed first.
  3. For the symbols that intersect the same tile border(s), and have equal minimal section length, we look at the anchor coordinates.
  4. Finally, if all the previous criteria are the same, we look at the symbol key hashes.

• [core][tile mode] Fix variable placement for labels with the icon-text-fit property set (#16382)

  The symbolIntersectsTileEdges() util in mbgl::TilePlacement now considers icon shift for the variable symbols with enabled icon-text-fit setting, thus providing more accurate results.

• [core] Correctly log a warning instead of crashing when a non-existent image is attempted to be removed. (#16391)

• [core] Fix segfault resulting from an invalid geometry (#16409)

• [macos] Restored support for macOS 10.11–10.14 (#16412)

maps-v1.5.1

🐞 Bug fixes

• [core] Fix assert in gfx resources cleanup (#16349)

  Fix a resource leak assertion in gl::Context::~Context() that is evaluating false in scenarios where graphics context has been marked as lost.

• Hillshade bucket fix for mapbox-gl-native-ios #240 (#16362)

  When dem tiles are loaded, border in neighboring tiles is updated, too leading to bucket re-upload. if std::move moved indices / vertices previously, they are empty and we get crash. Re-upload requires that only DEM texture is re-uploaded, not the quad vertices and indices.

maps-v1.5.0

✨ New features

• [core] Add Renderer::clearData() (#16323)

  The newly added Renderer::clearData() method allows to clear render data and thus save memory and make sure outdated tiles are not shown. It clears data more agressively than Renderer::reduceMemoryUse() does, as it clears not only the cache but all orchestration data, including the data used by the currently rendered frame.

• [android] Add jni binding for styleable snapshotter (#16286)

• [core] Ability to set generic layer properties using setProperty method (#16324) This change enables the following new keys for the mbgl::Layer::setProperty() API:

  • "filter" invokes setFilter()
  • "minzoom" invokes setMinZoom()
  • "maxzoom" invokes setMaxZoom()
  • "source-layer" invokes setSourceLayer()

  The newly-added API is used in the style-conversion code, which made this code much simpler.

• [android] Expose getLayer, getSource and Observer interface for snapshotter (#16338)

🐞 Bug fixes

• [core] Use TileCoordinates instead of LngLat for within expression calculation (#16319)

  Fix the issue that within expression evaluates point features inconsistently across zoom levels if the point lies near the boundary of a GeoJSON object (#16301)

• [core][tile mode] Reduce cut-off labels (#16336)

  Place tile intersecting labels first, across all the layers. Thus we reduce the amount of label cut-offs in Tile mode.

  Before, labels were arranged within one symbol layer (one bucket),which was not enough for several symbol layers being placed at the same time.

• [core] Fix issue that within expression returns incorrect results for geometries crossing the anti-meridian (#16330)

maps-v1.4.1

🐞 Bug fixes

• [android] Fix wrong method call in map_snapshotter (#16308)

  In map_snapshotter, a wrong method call will cause Sanpshotter not works with a style url in Android. This change makes it call the right method to let Snapshotter works.

maps-v1.4.0

✨ New features

• [android] Add jni binding for line-sort-key and fill-sort-key (#16256)

  With this change, android sdk will be able to get sort key for LineLayer and FillLayer.

• Styleable MapSnapshotter (#16268)

  New feature provides means of modifying style of a MapSnapshotter. The new API enables several use-cases, such as: adding route overlays, removing extra information (layers) from a base style, adding custom images that are missing from a style.

• [core] Improve stability of symbol placement when the map is tilted (#16287)

  These changes improve performance and bring more stability to the symbol placement for the tilted view, which is mainly used for navigation scenarios.

🐞 Bug fixes

• [core] Fix iterators in addRegularDash() (#16249)

  Fixes possible crashes when using styles with line patterns.

• [default] Fix possible crash at RunLoop::wake() (#16255)

• [android] Update toGeoJSON in android_conversion.hpp (#16243)

  Before this chage, toGeoJSON method in android_conversion.hpp could not convert an Object (Map in android) to GeoJSON object.

  But within expression needs to accept an Object and then convert it to the GeoJSON object, now toGeoJSON method can convert both string and Object to GeoJSON.

• [core] Fix within expression algorithm so that false value will be returned when point is on the boundary. Allow using different GeoJSON formats as arguments of within expression.(#16232)

  A valid GeoJSON argument should contain one of the following types: "Feature", "FeatureCollection","Polygon" or "MultiPolygon".

• [core] [tile mode] placement algorithm must consider icons bounding boxes (#16277)

  Tile mode placement algorithm now checks if bounding boxes for both label text and icon are intersecting the edges of the tiles.

  Before, it checked only text bounding boxes and thus label icons might have got cut off.

• [core] Calculate size of an ambient cache without offline region's resources (#15622)

  Resources that belong to an offline region, should not contribute to the amount of space available in the ambient cache.

• [core][tile mode] Fix assertion at line-center placement handling (#16293)

The Symbol Intersects Tile Edges placement algorithm should not be applied to the symbols with line-center placement.

• Fixed using of the in expression as a layer filter (#16272)

The bug was caused by mbgl::style::conversion::isExpression() always returning false for the in expression.

🧩 Architectural changes

• Changes to MapSnapshotter threading model (#16268)

  Snapshotter's threading model has been changed. Previously, Map and HeadlessFrontend that is responsible for rendering snapshot, were running on a dedicated thread. After #16268, Map object lives on client thread, so that the client can access Style object, while HeadlessFrontend lives on a dedicated Snapshotter thread.

⚠️ Breaking changes

• Signature of a MapSnapshotter's constructor has been changed
• Signature for a MapSnapshotter::snapshot method has been changed
• Size of an offline regions do not affect ambient cache size (#15622)

📌 Known issues

• When feature is exactly on the geometry boundary, within expression returns inconsistent values for different zoom levels (#16301)

maps-v1.3.0 (2020.02-relvanillashake)

🐞 Bug fixes

• [core] Fix offline region download freezing (#16230)

  Downloaded resources are put in the buffer and inserted in the database in batches.

  Before this change, the buffer was flushed only at the network response callback and thus it never got flushed if the last required resources were present locally and did not initiate network requests - it caused freezing.

  Now the buffer is flushed every time the remaining resources container gets empty.

✨ New features

• [core] Add Layer::serialize() method (#16231)

  New method allows serialization of a layer into a Value type, including all modifications done via runtime style API. New method is also an enabler for Style object serialization (sources, layers, etc).

• [android] Add jni binding for min and max pitch (#16236)

• [offline] Offline tool does not hang on 404 error (#16240)

  The missing resource gets skipped and teh offline region download continues.

⚠️ Breaking changes

• Changes to mbgl::FileSourceManager::getFileSource() (#16238)

  It returns now mbgl::PassRefPtr<FileSource> (previously was std::shared_ptr<FileSource>) in order to enforce keeping the strong reference to the returned object.

  Breaking code example: auto fs = FileSourceManager::getFileSource(); fs->..

  Posible fix: std::shared_ptr<FileSource> fs = ;

• The mbgl::OnlineFileSource class cannot be used directly (#16238)

  Clients must use the parent mbgl::FileSource interface instead.

  Breaking code example: std::shared_ptr<OnlineFileSource> onlineSource = std::static_pointer_cast<OnlineFileSource>(FileSourceManager::get()->getFileSource(..));

  Possible fix: std::shared_ptr<FileSource> onlineSource = FileSourceManager::get()->getFileSource(..);

maps-v1.2.1 (2020.02-release-vanillashake)

🐞 Bug fixes

• [core] Revert shader changes from #16189, which will cause incorrect label positioning (#16235)

  This is a back porting from GL JS #9333

• [ios] Restored support for iOS 9–11 by default (#16241)

maps-v1.2.0 (2020.02-release-vanillashake)

✨ New features

• [core] Global settings API (#16174)

  Global settings API provides means of managing non-persistent in-process settings. Initial implementation contains support for experimental option for setting thread priorities.

• Expose READ_ONLY_MODE_KEY property for DatabaseFileSource (#16183)

  The READ_ONLY_MODE_KEY property is exposed for DatabaseFileSource.

  This property allows to re-open the offline database in read-only mode and thus improves the performance for the set-ups that do not require the offline database modifications.

• [core] Add runtime API for setting tile prefetch delta for a Source (#16179)

  The new Source::setPrefetchZoomDelta(optional<uint8_t>) method allows overriding default tile prefetch setting that is defined by the Map instance.

• [core] Add support for within expression. Implement the use of within expression with paint propery and filter expression. (#16157)

  The within expression enables checking whether a feature is inside a pre-defined geometry set/boundary or not. This within expression returns a boolean value, true indicates that the feature being evaluated is inside the geometry set. The returned value can be then consumed as input by another expression or used directly by a paint/layer property.

  Support for using within expression with layout property will be implemented separately.

• [core] Add support for using within expression with layout property. (#16194)

• [core] Add support for in expression. (#16162)

  The in expression enables checking whether a Number/String/Boolean type item is in a String/Array and returns a boolean value.

• [core] Add support for using within expression with features having 'LineString' geometry type. (#16220)

  within expression now supports features with geometry types: 'Point' or 'LineString'.

🐞 Bug fixes

• [core] Don't provide multiple responses with the same data for 304 replies (#16200)

  In cases when cached resource is useable, yet don't have an expiration timestamp, we provided data to the requester from the cache and the same data was returned once 304 response was received from the network.

• [core] Fix potential visual artifact for line-dasharray (#16202)

• Store gfx::DrawScope objects with associated render objects. (#15395)

  We used some shared SegmentVectors, e.g. for drawing raster or background tiles. In longer running maps, this lead to resource accumulation. By storing the SegmentVectors and the contained gfx::DrawScope objects, we ensure that resources get released when the associated render objects vanish.

• [core] Fix sprite sheet merging in Style::Impl::onSpriteLoaded (#16211)

  If we get a new sprite sheet from the server, we need to merge current sprite sheet with a new one, while overwriting duplicates and keeping old unique images in a style.

🏁 Performance improvements

• [core] Loading images to style optimization (#16187)

  This change enables attaching images to the style with batches and avoids massive re-allocations. Thus, it improves UI performance especially at start-up time.

🧩 Architectural changes

⚠️ Breaking changes

• [core] Loading images to style optimization (#16187)

  The style::Style::getImage() semantics changed - it now returns optional<style::Image>.

maps-v1.0.1 (2020.01-release-unicorn)

🐞 Bug fixes

• [core] Use std::list instead of std::map for factory instance (#16161)

  Factory 'get' method can be invoked recursively and stable iterators are required to guarantee safety.

• [tile mode] Improvements in symbol placement on tile borders (#16159)

  In tile mode, the placement order of two symbols crossing a tile border is defined by their anchor Y values.

  Symbols crossing the borders between two neighboring tiles are placed with priority.

  It improves symbol placement stability in the tile map mode.

maps-v1.0.0 (2020.01-release-unicorn)

✨ New features

• [core] Implement stretchable icons (#16030)

  Stretchable icons allow defining certain areas of an icon that may be stretched, leaving the remaining areas of an icon at a fixed size.

• [core] Port line-sort-key and fill-sort-key (#15839)

  The new feature allows to sort line and fill layer features. Similar to symbol-sort-key.

• [core] Add image sections to format expression (#15937)

  The new feature allows to embed images into labels.

• [core] Introduce OfflineDatabase::runPackDatabaseAutomatically() API (#15967)

  The new API allows to enable / disable automatic packing of a database.

• [core] Decouple offline storage vacuum and the deleteRegion API (#15899)

  • introduce OfflineDatabase::pack() standing for incremental vacuum
  • make packing optional at offline region deletion

• [core] Implement image expression (#15877)

  The image expression allows determining an image's availability.

• [core] Add batch conversion of latLngs to/from screenCoords (#15891)

  This patch introduces batch conversion between LatLng and ScreenCoordinate in Gl-Native core, so for multiple conversions with single point/latLng previously now it can be done with invoking one function call by passing vector of points/latLngs.

🐞 Bug fixes

• [tile mode] Fix variable symbols placement (#16141

  This change allows the variable symbols to cross the tile border only if their anchor is the first anchor from the text-variable-anchor list.

• [core] Use weak scheduler inside mailbox (#16136)

  If there are pending requests that are completed after main scheduler is destructed, worker threads may try to push messages to destructed scheduler's queue.

• [core] Fix a crash in GeoJSON source parsing, caused by GeoJSONVTData ownership error (#16106)

• [core] Stable position of labels at tile borders in tile mode (#16040)

  These changes allow to avoid cutting-off labels on tile borders if the variable text placement is enabled.

• [core] Fix really overscaled lines (#16045)

  We resample lines after sharp corners in some situations. When tiles were really overscaled, sometimes we didn't have enough precision to represent the resampled vertex because it was too close. Disabling this after a certain point prevents this (#16018).

• [core] Don't use signed int type for anchor segment (#16008)

  Erroneous signed to unsigned implicit conversion was used when PlacedSymbol(s) were created in SymbolLayout and signed values were used as indexes in a few other places.

• [core] Increase padding in CollisionIndex for MapMode::Tile (#15880)

  This increases the padding to 1024 for MapMode::Tile which should be enough to completely include all the data two zoom levels past the data source's max zoom level. Beyond that, 1024 should be enough of a padding to make clipped labels unlikely.

• [core] Blacklist VAO extension for Adreno (TM) 4xx GPUs (#15978)

  Blacklist in order to avoid crashes in a driver (Android 5.1.1)

• [core] Retain thread pool in GeoJSONSource (#15992)

  Otherwise, the construction of the Immutable<Source::Impl> in background thread might never yeld.

• [core] Fix supercluster lambdas capturing (#15989)

  Fix wrapping of the parameters in supercluster map/reduce lambdas (Previously, local variables were wrapped by reference).

• [core] fix rendering of dashed lines with round caps (#15947)

  In #15862, we introduced individual textures for line dash patterns to eliminate atlas overflows. Unfortunately, this broke dashed lines that had round caps (dashed lines with straight caps still rendered correctly). Line pattern textures for round caps were now using 256×15 pixel textures.

• [core] Fix incorrect resizing of TileCache (#15943)

• [core] Avoid GeoJSON source flickering on style transitions (#15907)

  Before this change, all GeoJSON source cleared tile pyramid at the style transition and it caused flickering.

• [core] Use individual textures for line dash patterns (#15862)

  This moves the LineAtlas from a shared texture that contained SDF dash patterns to use individual textures.

• [core] Fix collisions with icon-text-fit and variable placement (#15828)

  When deciding the placement position it was only checking whether there were text collisions. Now, if icon-text-fit is used it now checks whether the icon fits before accepting a placement position.

• [core] Fix icon-text-fit (#15634)

  This fixes rendering by account for the 1px texture padding around icons that were stretched with icon-text-fit.

🏁 Performance improvements

• [core] Cross tile index performance (#16127)

  For overscaled tiles, index only the symbols inside the viewport.

  Find matches only among the buckets that have the same leader Id.

• [core] Calculate GeoJSON tile geometries in a background thread (#15953)

  Call mapbox::geojsonvt::GeoJSONVT::getTile() in a background thread, so that the rendering thread is not blocked.

• [core] Make requests for expired resources lower priority than requests for new resources (#15950)

• [core] Add Scheduler::scheduleAndReplyValue() API (#15885)

  This change converts GeoJSON features to tiles for the loaded source description in a background thread and thus unblock the UI thread.

• [core] Enable incremental vacuum for Offline DB (#15837)

  Thus we avoid re-creating the whole database and keeping the backup file as it happens on calling VACUUM.

• [core] Fix image requests for already obtained images (#15825)

  Before this fix, repeated request for an already obtained image was erroneously treated as pending, and it prevented from the tiles load completion.

🧩 Architectural changes

• [core] Merge style::Layer::set{Layout,Paint}Property (#15997)

• [core] Use expected.hpp from mapbox-base (#15898)

⚠️ Breaking changes

• [core] Cross tile index performance (#16127)

  Introduces public mblg::Renderer::render API break.

• [core] Refactor DefaultFileSource codebase (#15768)

  • Adds FileSourceManager interface that provides access to FileSource instances and means of registering / unregistering FileSource factories
  • Splits DefaultFileSource into smaller parts
  • Adds DatabaseFileSource interface and it's default implementation
  • Removes inter-dependencies between concrete FileSource classes
  • All sources operate on dedicated thread, except MainResourceLoader that acts as a dispatcher and works on thread that requested it.
  • Removes ResourceOptions::withCacheOnlyRequestsSupport method

• [core] Remove Map::cycleDebugOptions (#16005)

  This function was mostly used by the Android API, which is no longer necessary.