@versatiles/png-renderer 2.5.0 → 2.6.0

package/README.md

@@ -116,7 +116,7 @@ Which MapLibre GL JS features are covered, and which are not yet: [MapLibre GL J
 
 ### `new PNGMapRenderer(options)`
 
-An [`SVGMapRenderer`](https://github.com/versatiles-org/versatiles-svg-renderer/blob/main/packages/svg-renderer/README.md#new-svgmaprendereroptions) that can also render PNG. It takes the options of `SVGMapRenderer` (`style`, `renderLabels`, `tileCacheSize`, `fetch`), plus `fonts` as above.
+An [`SVGMapRenderer`](https://github.com/versatiles-org/versatiles-svg-renderer/blob/main/packages/svg-renderer/README.md#new-svgmaprendereroptions) that can also render PNG. It takes the options of `SVGMapRenderer` (e.g. `style`, `labels`, `tileCacheSize`, `fetch`, `images`), plus `fonts` as above.
 
 - **`renderPNG(view?): Promise<Uint8Array>`** renders one view as PNG. `view` takes `width`, `height`, `lon`, `lat`, `zoom` and `scale`, with the same defaults as `renderToPNG`.
 - **`renderCanvas(view?): Promise<Canvas>`** renders one view onto a canvas, to draw on or to encode in another format; see [above](#drawing-on-the-map-or-saving-another-format).

package/dist/index.d.ts

@@ -2282,6 +2282,15 @@ type RasterLayerSpecification = {
      */
     "raster-opacity"?: PropertyValueSpecification<number>;
     "raster-opacity-transition"?: TransitionSpecification;
+    /**
+     * Controls how the layer is composited with the content already rendered beneath it. Unlike [`raster-opacity`](#raster-opacity), which only fades the layer, this property determines how its colors interact with the existing map contents.
+     *
+     * @default
+     * ```json
+     * "normal"
+     * ```
+     */
+    "raster-layer-blend"?: "normal" | "multiply" | "color" | "luminosity" | "plus-lighter" | "screen" | "overlay";
     /**
      * Rotates hues around the color wheel.
      */
@@ -3167,6 +3176,32 @@ interface FetchRequestInit {
  */
 type FetchFunction = (url: string, init?: FetchRequestInit) => Promise<FetchResponse>;
 
+/**
+ * An image that the style uses besides those of its sprite, as MapLibre GL JS takes it with
+ * `map.addImage(id, { width, height, data }, { pixelRatio, sdf })`.
+ */
+interface StyleImage {
+    /** The name that the style uses, e.g. in `icon-image` or `fill-pattern`. No sprite id is put before it. */
+    id: string;
+    /** Width in pixels. */
+    width: number;
+    /** Height in pixels. */
+    height: number;
+    /** The pixels as RGBA, row by row, not premultiplied: `width * height * 4` bytes. */
+    data: Uint8Array | Uint8ClampedArray;
+    /**
+     * Image pixels per pixel of the map, e.g. `2` for an image drawn at half its size.
+     * @defaultValue `1`
+     */
+    pixelRatio?: number;
+    /**
+     * Whether the image is a signed distance field, as a sprite image can be: only its alpha
+     * channel counts, and `icon-color` and the icon halo color it.
+     * @defaultValue `false`
+     */
+    sdf?: boolean;
+}
+
 /** Options for {@link SVGMapRenderer}: what stays the same for every view of the map. */
 interface SVGMapRendererOptions {
     /**
@@ -3253,6 +3288,19 @@ interface SVGMapRendererOptions {
      * @defaultValue the defaults of the style's `state`
      */
     globalState?: GlobalState;
+    /**
+     * Images that the style uses besides those of its sprite, like `map.addImage(id, image,
+     * { pixelRatio, sdf })` in MapLibre GL JS: for `icon-image`, `fill-pattern`, `line-pattern`
+     * and `background-pattern`, by their `id`, which no sprite id is put before. An SDF image is
+     * colored by `icon-color` and its halo, like one of the sprite.
+     *
+     * As in MapLibre GL JS, where `addImage` fails for an id that exists, an image of the sprite
+     * with the same id is drawn instead, reported through
+     * {@link SVGMapRendererOptions.onWarning}. In an SVG, each image is a data URI of a PNG file
+     * without compression.
+     * @defaultValue none
+     */
+    images?: readonly StyleImage[];
 }
 /** The view to render: size, centre and zoom. */
 interface ViewOptions {
@@ -3600,4 +3648,4 @@ declare class PNGMapRenderer extends SVGMapRenderer {
 }
 
 export { PNGMapRenderer, SVGMapRenderer, renderToCanvas, renderToPNG, renderToSVG };
-export type { FetchFunction, FetchRequestInit, FetchResponse, GlobalState, PNGMapRendererOptions, PNGViewOptions, RenderToPNGOptions, RenderToSVGOptions, SVGMapRendererOptions, ViewOptions };
+export type { FetchFunction, FetchRequestInit, FetchResponse, GlobalState, PNGMapRendererOptions, PNGViewOptions, RenderToPNGOptions, RenderToSVGOptions, SVGMapRendererOptions, StyleImage, ViewOptions };