maplibre-gl 3.1.0 → 3.2.0-pre.2

package/src/render/draw_fill_extrusion.ts

@@ -1,23 +1,21 @@
-import DepthMode from '../gl/depth_mode';
-import StencilMode from '../gl/stencil_mode';
-import ColorMode from '../gl/color_mode';
-import CullFaceMode from '../gl/cull_face_mode';
+import {DepthMode} from '../gl/depth_mode';
+import {StencilMode} from '../gl/stencil_mode';
+import {ColorMode} from '../gl/color_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
 import {
     fillExtrusionUniformValues,
     fillExtrusionPatternUniformValues,
 } from './program/fill_extrusion_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type FillExtrusionStyleLayer from '../style/style_layer/fill_extrusion_style_layer';
-import type FillExtrusionBucket from '../data/bucket/fill_extrusion_bucket';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {FillExtrusionStyleLayer} from '../style/style_layer/fill_extrusion_style_layer';
+import type {FillExtrusionBucket} from '../data/bucket/fill_extrusion_bucket';
 import type {OverscaledTileID} from '../source/tile_id';
 
-import updatePatternPositionsInProgram from './update_pattern_positions_in_program';
+import {updatePatternPositionsInProgram} from './update_pattern_positions_in_program';
 
-export default draw;
-
-function draw(painter: Painter, source: SourceCache, layer: FillExtrusionStyleLayer, coords: Array<OverscaledTileID>) {
+export function drawFillExtrusion(painter: Painter, source: SourceCache, layer: FillExtrusionStyleLayer, coords: Array<OverscaledTileID>) {
     const opacity = layer.paint.get('fill-extrusion-opacity');
     if (opacity === 0) {
         return;

package/src/render/draw_heatmap.ts

@@ -1,25 +1,23 @@
-import Texture from './texture';
+import {Texture} from './texture';
 import {Color} from '@maplibre/maplibre-gl-style-spec';
-import DepthMode from '../gl/depth_mode';
-import StencilMode from '../gl/stencil_mode';
-import ColorMode from '../gl/color_mode';
-import CullFaceMode from '../gl/cull_face_mode';
-import Context from '../gl/context';
-import Framebuffer from '../gl/framebuffer';
+import {DepthMode} from '../gl/depth_mode';
+import {StencilMode} from '../gl/stencil_mode';
+import {ColorMode} from '../gl/color_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
+import {Context} from '../gl/context';
+import {Framebuffer} from '../gl/framebuffer';
 import {
     heatmapUniformValues,
     heatmapTextureUniformValues
 } from './program/heatmap_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type HeatmapStyleLayer from '../style/style_layer/heatmap_style_layer';
-import type HeatmapBucket from '../data/bucket/heatmap_bucket';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {HeatmapStyleLayer} from '../style/style_layer/heatmap_style_layer';
+import type {HeatmapBucket} from '../data/bucket/heatmap_bucket';
 import type {OverscaledTileID} from '../source/tile_id';
 
-export default drawHeatmap;
-
-function drawHeatmap(painter: Painter, sourceCache: SourceCache, layer: HeatmapStyleLayer, coords: Array<OverscaledTileID>) {
+export function drawHeatmap(painter: Painter, sourceCache: SourceCache, layer: HeatmapStyleLayer, coords: Array<OverscaledTileID>) {
     if (layer.paint.get('heatmap-opacity') === 0) {
         return;
     }

package/src/render/draw_hillshade.ts

@@ -1,22 +1,20 @@
-import Texture from './texture';
-import StencilMode from '../gl/stencil_mode';
-import DepthMode from '../gl/depth_mode';
-import CullFaceMode from '../gl/cull_face_mode';
-import ColorMode from '../gl/color_mode';
-import Tile from '../source/tile';
+import {Texture} from './texture';
+import {StencilMode} from '../gl/stencil_mode';
+import {DepthMode} from '../gl/depth_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
+import {ColorMode} from '../gl/color_mode';
+import {Tile} from '../source/tile';
 import {
     hillshadeUniformValues,
     hillshadeUniformPrepareValues
 } from './program/hillshade_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type HillshadeStyleLayer from '../style/style_layer/hillshade_style_layer';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {HillshadeStyleLayer} from '../style/style_layer/hillshade_style_layer';
 import type {OverscaledTileID} from '../source/tile_id';
 
-export default drawHillshade;
-
-function drawHillshade(painter: Painter, sourceCache: SourceCache, layer: HillshadeStyleLayer, tileIDs: Array<OverscaledTileID>) {
+export function drawHillshade(painter: Painter, sourceCache: SourceCache, layer: HillshadeStyleLayer, tileIDs: Array<OverscaledTileID>) {
     if (painter.renderPass !== 'offscreen' && painter.renderPass !== 'translucent') return;
 
     const context = painter.context;

package/src/render/draw_line.ts

@@ -1,6 +1,6 @@
-import DepthMode from '../gl/depth_mode';
-import CullFaceMode from '../gl/cull_face_mode';
-import Texture from './texture';
+import {DepthMode} from '../gl/depth_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
+import {Texture} from './texture';
 import {
     lineUniformValues,
     linePatternUniformValues,
@@ -8,16 +8,16 @@ import {
     lineGradientUniformValues
 } from './program/line_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type LineStyleLayer from '../style/style_layer/line_style_layer';
-import type LineBucket from '../data/bucket/line_bucket';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {LineStyleLayer} from '../style/style_layer/line_style_layer';
+import type {LineBucket} from '../data/bucket/line_bucket';
 import type {OverscaledTileID} from '../source/tile_id';
 import {clamp, nextPowerOfTwo} from '../util/util';
 import {renderColorRamp} from '../util/color_ramp';
-import EXTENT from '../data/extent';
+import {EXTENT} from '../data/extent';
 
-export default function drawLine(painter: Painter, sourceCache: SourceCache, layer: LineStyleLayer, coords: Array<OverscaledTileID>) {
+export function drawLine(painter: Painter, sourceCache: SourceCache, layer: LineStyleLayer, coords: Array<OverscaledTileID>) {
     if (painter.renderPass !== 'translucent') return;
 
     const opacity = layer.paint.get('line-opacity');

package/src/render/draw_raster.ts

@@ -1,20 +1,18 @@
 import {clamp} from '../util/util';
 
-import ImageSource from '../source/image_source';
-import browser from '../util/browser';
-import StencilMode from '../gl/stencil_mode';
-import DepthMode from '../gl/depth_mode';
-import CullFaceMode from '../gl/cull_face_mode';
+import {ImageSource} from '../source/image_source';
+import {browser} from '../util/browser';
+import {StencilMode} from '../gl/stencil_mode';
+import {DepthMode} from '../gl/depth_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
 import {rasterUniformValues} from './program/raster_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type RasterStyleLayer from '../style/style_layer/raster_style_layer';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {RasterStyleLayer} from '../style/style_layer/raster_style_layer';
 import type {OverscaledTileID} from '../source/tile_id';
 
-export default drawRaster;
-
-function drawRaster(painter: Painter, sourceCache: SourceCache, layer: RasterStyleLayer, tileIDs: Array<OverscaledTileID>) {
+export function drawRaster(painter: Painter, sourceCache: SourceCache, layer: RasterStyleLayer, tileIDs: Array<OverscaledTileID>) {
     if (painter.renderPass !== 'translucent') return;
     if (layer.paint.get('raster-opacity') === 0) return;
     if (!tileIDs.length) return;

package/src/render/draw_symbol.test.ts

@@ -1,19 +1,19 @@
 import {mat4} from 'gl-matrix';
 import {OverscaledTileID} from '../source/tile_id';
-import SymbolBucket from '../data/bucket/symbol_bucket';
-import SourceCache from '../source/source_cache';
-import Tile from '../source/tile';
-import SymbolStyleLayer from '../style/style_layer/symbol_style_layer';
-import Painter from './painter';
-import Program from './program';
-import drawSymbol from './draw_symbol';
+import {SymbolBucket} from '../data/bucket/symbol_bucket';
+import {SourceCache} from '../source/source_cache';
+import {Tile} from '../source/tile';
+import {SymbolStyleLayer} from '../style/style_layer/symbol_style_layer';
+import {Painter} from './painter';
+import {Program} from './program';
+import {drawSymbols} from './draw_symbol';
 import * as symbolProjection from '../symbol/projection';
-import type ZoomHistory from '../style/zoom_history';
-import type Map from '../ui/map';
-import Transform from '../geo/transform';
-import type EvaluationParameters from '../style/evaluation_parameters';
+import type {ZoomHistory} from '../style/zoom_history';
+import type {Map} from '../ui/map';
+import {Transform} from '../geo/transform';
+import type {EvaluationParameters} from '../style/evaluation_parameters';
 import type {SymbolLayerSpecification} from '@maplibre/maplibre-gl-style-spec';
-import Style from '../style/style';
+import {Style} from '../style/style';
 
 jest.mock('./painter');
 jest.mock('./program');
@@ -27,7 +27,7 @@ describe('drawSymbol', () => {
         const mockPainter = new Painter(null, null);
         mockPainter.renderPass = 'opaque';
 
-        drawSymbol(mockPainter, null, null, null, null);
+        drawSymbols(mockPainter, null, null, null, null);
 
         expect(mockPainter.colorModeForRenderPass).not.toHaveBeenCalled();
     });
@@ -88,7 +88,7 @@ describe('drawSymbol', () => {
         (sourceCacheMock.getTile as jest.Mock).mockReturnValue(tile);
         sourceCacheMock.map = {showCollisionBoxes: false} as any as Map;
 
-        drawSymbol(painterMock, sourceCacheMock, layer, [tileId], null);
+        drawSymbols(painterMock, sourceCacheMock, layer, [tileId], null);
 
         expect(programMock.draw).toHaveBeenCalledTimes(1);
     });
@@ -154,7 +154,7 @@ describe('drawSymbol', () => {
         } as any as Style;
 
         const spy = jest.spyOn(symbolProjection, 'updateLineLabels');
-        drawSymbol(painterMock, sourceCacheMock, layer, [tileId], null);
+        drawSymbols(painterMock, sourceCacheMock, layer, [tileId], null);
 
         expect(spy.mock.calls[0][9]).toBeFalsy(); // rotateToLine === false
     });
@@ -215,7 +215,7 @@ describe('drawSymbol', () => {
         (sourceCacheMock.getTile as jest.Mock).mockReturnValue(tile);
         sourceCacheMock.map = {showCollisionBoxes: false} as any as Map;
 
-        drawSymbol(painterMock, sourceCacheMock, layer, [tileId], null);
+        drawSymbols(painterMock, sourceCacheMock, layer, [tileId], null);
 
         expect(programMock.draw).toHaveBeenCalledTimes(0);
     });

package/src/render/draw_symbol.ts

@@ -1,14 +1,14 @@
 import Point from '@mapbox/point-geometry';
-import drawCollisionDebug from './draw_collision_debug';
+import {drawCollisionDebug} from './draw_collision_debug';
 
-import SegmentVector from '../data/segment';
-import pixelsToTileUnits from '../source/pixels_to_tile_units';
+import {SegmentVector} from '../data/segment';
+import {pixelsToTileUnits} from '../source/pixels_to_tile_units';
 import * as symbolProjection from '../symbol/projection';
 import {EvaluatedZoomSize, evaluateSizeForFeature, evaluateSizeForZoom} from '../symbol/symbol_size';
 import {mat4} from 'gl-matrix';
-import StencilMode from '../gl/stencil_mode';
-import DepthMode from '../gl/depth_mode';
-import CullFaceMode from '../gl/cull_face_mode';
+import {StencilMode} from '../gl/stencil_mode';
+import {DepthMode} from '../gl/depth_mode';
+import {CullFaceMode} from '../gl/cull_face_mode';
 import {addDynamicAttributes} from '../data/bucket/symbol_bucket';
 
 import {getAnchorAlignment, WritingMode} from '../symbol/shaping';
@@ -22,22 +22,21 @@ import {
     symbolTextAndIconUniformValues
 } from './program/symbol_program';
 
-import type Painter from './painter';
-import type SourceCache from '../source/source_cache';
-import type SymbolStyleLayer from '../style/style_layer/symbol_style_layer';
+import type {Painter} from './painter';
+import type {SourceCache} from '../source/source_cache';
+import type {SymbolStyleLayer} from '../style/style_layer/symbol_style_layer';
 
-import type Texture from '../render/texture';
+import type {Texture} from '../render/texture';
 import type {OverscaledTileID} from '../source/tile_id';
 import type {UniformValues} from './uniform_binding';
 import type {SymbolSDFUniformsType} from '../render/program/symbol_program';
 import type {CrossTileID, VariableOffset} from '../symbol/placement';
-import type SymbolBucket from '../data/bucket/symbol_bucket';
-import type {SymbolBuffers} from '../data/bucket/symbol_bucket';
+import type {SymbolBucket, SymbolBuffers} from '../data/bucket/symbol_bucket';
 import type {TerrainData} from '../render/terrain';
 import type {SymbolLayerSpecification} from '@maplibre/maplibre-gl-style-spec';
-import type Transform from '../geo/transform';
-import type ColorMode from '../gl/color_mode';
-import type Program from './program';
+import type {Transform} from '../geo/transform';
+import type {ColorMode} from '../gl/color_mode';
+import type {Program} from './program';
 
 type SymbolTileRenderState = {
     segments: SegmentVector;
@@ -58,7 +57,7 @@ type SymbolTileRenderState = {
 
 const identityMat4 = mat4.identity(new Float32Array(16));
 
-export default function drawSymbols(painter: Painter, sourceCache: SourceCache, layer: SymbolStyleLayer, coords: Array<OverscaledTileID>, variableOffsets: {
+export function drawSymbols(painter: Painter, sourceCache: SourceCache, layer: SymbolStyleLayer, coords: Array<OverscaledTileID>, variableOffsets: {
     [_ in CrossTileID]: VariableOffset;
 }) {
     if (painter.renderPass !== 'translucent') return;

package/src/render/draw_terrain.ts

@@ -1,17 +1,17 @@
-import StencilMode from '../gl/stencil_mode';
-import DepthMode from '../gl/depth_mode';
+import {StencilMode} from '../gl/stencil_mode';
+import {DepthMode} from '../gl/depth_mode';
 import {terrainUniformValues, terrainDepthUniformValues, terrainCoordsUniformValues} from './program/terrain_program';
-import type Painter from './painter';
-import type Tile from '../source/tile';
-import CullFaceMode from '../gl/cull_face_mode';
+import type {Painter} from './painter';
+import type {Tile} from '../source/tile';
+import {CullFaceMode} from '../gl/cull_face_mode';
 import {Color} from '@maplibre/maplibre-gl-style-spec';
-import ColorMode from '../gl/color_mode';
-import Terrain from './terrain';
+import {ColorMode} from '../gl/color_mode';
+import {Terrain} from './terrain';
 
 /**
  * Redraw the Depth Framebuffer
- * @param {Painter} painter - the painter
- * @param {Terrain} terrain - the terrain
+ * @param painter - the painter
+ * @param terrain - the terrain
  */
 function drawDepth(painter: Painter, terrain: Terrain) {
     const context = painter.context;
@@ -36,8 +36,8 @@ function drawDepth(painter: Painter, terrain: Terrain) {
 
 /**
  * Redraw the Coords Framebuffers
- * @param {Painter} painter - the painter
- * @param {Terrain} terrain - the terrain
+ * @param painter - the painter
+ * @param terrain - the terrain
  */
 function drawCoords(painter: Painter, terrain: Terrain) {
     const context = painter.context;

package/src/render/glyph_atlas.ts

@@ -6,6 +6,9 @@ import type {GlyphMetrics, StyleGlyph} from '../style/style_glyph';
 
 const padding = 1;
 
+/**
+ * A rectangle type with postion, width and height.
+ */
 export type Rect = {
     x: number;
     y: number;
@@ -13,18 +16,24 @@ export type Rect = {
     h: number;
 };
 
+/**
+ * The glyph's position
+ */
 export type GlyphPosition = {
     rect: Rect;
     metrics: GlyphMetrics;
 };
 
+/**
+ * The glyphs' positions
+ */
 export type GlyphPositions = {
     [_: string]: {
         [_: number]: GlyphPosition;
     };
 };
 
-export default class GlyphAtlas {
+export class GlyphAtlas {
     image: AlphaImage;
     positions: GlyphPositions;
 

package/src/render/glyph_manager.test.ts

@@ -1,10 +1,10 @@
-import parseGlyphPBF from '../style/parse_glyph_pbf';
-import GlyphManager from './glyph_manager';
+import {parseGlyphPbf} from '../style/parse_glyph_pbf';
+import {GlyphManager} from './glyph_manager';
 import fs from 'fs';
 import {RequestManager} from '../util/request_manager';
 
 const glyphs = {};
-for (const glyph of parseGlyphPBF(fs.readFileSync('./test/unit/assets/0-255.pbf'))) {
+for (const glyph of parseGlyphPbf(fs.readFileSync('./test/unit/assets/0-255.pbf'))) {
     glyphs[glyph.id] = glyph;
 }
 

package/src/render/glyph_manager.ts

@@ -1,7 +1,7 @@
-import loadGlyphRange from '../style/load_glyph_range';
+import {loadGlyphRange} from '../style/load_glyph_range';
 
 import TinySDF from '@mapbox/tiny-sdf';
-import isChar from '../util/is_char_in_unicode_block';
+import {unicodeBlockLookup} from '../util/is_char_in_unicode_block';
 import {asyncAll} from '../util/util';
 import {AlphaImage} from '../util/image';
 
@@ -25,7 +25,7 @@ type Entry = {
     tinySDF?: TinySDF;
 };
 
-export default class GlyphManager {
+export class GlyphManager {
     requestManager: RequestManager;
     localIdeographFontFamily: string;
     entries: {
@@ -163,10 +163,10 @@ export default class GlyphManager {
     _doesCharSupportLocalGlyph(id: number): boolean {
         /* eslint-disable new-cap */
         return !!this.localIdeographFontFamily &&
-            (isChar['CJK Unified Ideographs'](id) ||
-                isChar['Hangul Syllables'](id) ||
-                isChar['Hiragana'](id) ||
-                isChar['Katakana'](id));
+            (unicodeBlockLookup['CJK Unified Ideographs'](id) ||
+            unicodeBlockLookup['Hangul Syllables'](id) ||
+            unicodeBlockLookup['Hiragana'](id) ||
+            unicodeBlockLookup['Katakana'](id));
         /* eslint-enable new-cap */
     }
 

package/src/render/image_atlas.ts

@@ -4,8 +4,8 @@ import {register} from '../util/web_worker_transfer';
 import potpack from 'potpack';
 
 import type {StyleImage} from '../style/style_image';
-import type ImageManager from './image_manager';
-import type Texture from './texture';
+import type {ImageManager} from './image_manager';
+import type {Texture} from './texture';
 import type {Rect} from './glyph_atlas';
 
 const IMAGE_PADDING: number = 1;
@@ -60,7 +60,10 @@ export class ImagePosition {
     }
 }
 
-export default class ImageAtlas {
+/**
+ * A class holding all the images
+ */
+export class ImageAtlas {
     image: RGBAImage;
     iconPositions: {[_: string]: ImagePosition};
     patternPositions: {[_: string]: ImagePosition};

package/src/render/image_manager.ts

@@ -4,12 +4,12 @@ import potpack from 'potpack';
 import {Event, ErrorEvent, Evented} from '../util/evented';
 import {RGBAImage} from '../util/image';
 import {ImagePosition} from './image_atlas';
-import Texture from './texture';
+import {Texture} from './texture';
 import {renderStyleImage} from '../style/style_image';
 import {warnOnce} from '../util/util';
 
 import type {StyleImage} from '../style/style_image';
-import type Context from '../gl/context';
+import type {Context} from '../gl/context';
 import type {PotpackBox} from 'potpack';
 import type {Callback} from '../types/callback';
 
@@ -35,7 +35,7 @@ const padding = 1;
     data-driven support for `*-pattern`, we'll likely use per-bucket pattern atlases, and that would be a good time
     to refactor this.
 */
-class ImageManager extends Evented {
+export class ImageManager extends Evented {
     images: {[_: string]: StyleImage};
     updatedImages: {[_: string]: boolean};
     callbackDispatchedThisFrame: {[_: string]: boolean};
@@ -326,5 +326,3 @@ class ImageManager extends Evented {
         }
     }
 }
-
-export default ImageManager;

package/src/render/line_atlas.test.ts

@@ -1,4 +1,4 @@
-import LineAtlas from './line_atlas';
+import {LineAtlas} from './line_atlas';
 
 describe('LineAtlas', () => {
     const lineAtlas = new LineAtlas(64, 64);

package/src/render/line_atlas.ts

@@ -1,23 +1,31 @@
 import {warnOnce} from '../util/util';
 
-import type Context from '../gl/context';
+import type {Context} from '../gl/context';
+
+/**
+ * A dash entry
+ */
+type DashEntry = {
+    y: number;
+    height: number;
+    width: number;
+}
 
 /**
  * A LineAtlas lets us reuse rendered dashed lines
  * by writing many of them to a texture and then fetching their positions
- * using .getDash.
+ * using {@link LineAtlas#getDash}.
  *
- * @param {number} width
- * @param {number} height
- * @private
+ * @param width - the width
+ * @param height - the height
  */
-class LineAtlas {
+export class LineAtlas {
     width: number;
     height: number;
     nextRow: number;
     bytes: number;
     data: Uint8Array;
-    dashEntry: {[_: string]: any};
+    dashEntry: {[_: string]: DashEntry};
     dirty: boolean;
     texture: WebGLTexture;
 
@@ -34,10 +42,9 @@ class LineAtlas {
     /**
      * Get or create a dash line pattern.
      *
-     * @param {Array<number>} dasharray
-     * @param {boolean} round whether to add circle caps in between dash segments
-     * @returns {Object} position of dash texture in { y, height, width }
-     * @private
+     * @param dasharray - the key (represented by numbers) to get the dash texture
+     * @param round - whether to add circle caps in between dash segments
+     * @returns position of dash texture in {@link DashEntry}
      */
     getDash(dasharray: Array<number>, round: boolean) {
         const key = dasharray.join(',') + String(round);
@@ -148,7 +155,7 @@ class LineAtlas {
         }
     }
 
-    addDash(dasharray: Array<number>, round: boolean) {
+    addDash(dasharray: Array<number>, round: boolean): DashEntry {
         const n = round ? 7 : 0;
         const height = 2 * n + 1;
 
@@ -204,5 +211,3 @@ class LineAtlas {
         }
     }
 }
-
-export default LineAtlas;