@pixerate/editor 0.151.0 → 0.152.0

package/dist/paint-editor/controller.d.cts

@@ -540,9 +540,13 @@ export declare class PaintEditorController {
     private readStrokePaint;
     setSecondaryColor(color: string): string;
     swapColors(): void;
-    /** The colour at a document pixel: of the composite (paper included) or of one layer. */
+    /**
+     * The colour at a document pixel: of the composite or of one layer. The composite includes the
+     * paper unless `paper` is false, so a pick where nothing is painted comes back with alpha 0.
+     */
     pickColor(x: number, y: number, options?: {
         layerId?: string;
+        paper?: boolean;
     }): {
         color: string;
         alpha: number;
@@ -753,10 +757,12 @@ export declare class PaintEditorController {
     /**
      * Composites the viewport stack (paper, view-only underlays, layers with the live stroke) tile by
      * tile over `rect`, calling `onTile` with each 256 px tile's RGBA (cached: unchanged tiles come back
-     * as the same buffer). Pass `takeDirty()` as `dirty`.
+     * as the same buffer). Pass `takeDirty()` as `dirty`. With `paper: false` the paper is left out and
+     * unpainted pixels stay transparent, for a host that draws the paint over its own surface.
      */
     compositeTiles(rect: RasterRect, onTile: (tx: number, ty: number, data: Uint8ClampedArray, changed: boolean) => void, options?: {
         dirty?: RasterRect[] | 'all';
+        paper?: boolean;
     }): void;
     /** The canvas as canvas-sized RGBA (paper included by default). */
     compositePixels(options?: RenderOptions): PixelImage;

package/dist/paint-editor/controller.d.ts

@@ -540,9 +540,13 @@ export declare class PaintEditorController {
     private readStrokePaint;
     setSecondaryColor(color: string): string;
     swapColors(): void;
-    /** The colour at a document pixel: of the composite (paper included) or of one layer. */
+    /**
+     * The colour at a document pixel: of the composite or of one layer. The composite includes the
+     * paper unless `paper` is false, so a pick where nothing is painted comes back with alpha 0.
+     */
     pickColor(x: number, y: number, options?: {
         layerId?: string;
+        paper?: boolean;
     }): {
         color: string;
         alpha: number;
@@ -753,10 +757,12 @@ export declare class PaintEditorController {
     /**
      * Composites the viewport stack (paper, view-only underlays, layers with the live stroke) tile by
      * tile over `rect`, calling `onTile` with each 256 px tile's RGBA (cached: unchanged tiles come back
-     * as the same buffer). Pass `takeDirty()` as `dirty`.
+     * as the same buffer). Pass `takeDirty()` as `dirty`. With `paper: false` the paper is left out and
+     * unpainted pixels stay transparent, for a host that draws the paint over its own surface.
      */
     compositeTiles(rect: RasterRect, onTile: (tx: number, ty: number, data: Uint8ClampedArray, changed: boolean) => void, options?: {
         dirty?: RasterRect[] | 'all';
+        paper?: boolean;
     }): void;
     /** The canvas as canvas-sized RGBA (paper included by default). */
     compositePixels(options?: RenderOptions): PixelImage;

package/dist/paint-editor/index.cjs

@@ -4332,7 +4332,10 @@ var PaintEditorController = (_class10 = class _PaintEditorController {
     [this.color, this.secondaryColor] = [this.secondaryColor, this.color];
     this.emit([]);
   }
-  /** The colour at a document pixel: of the composite (paper included) or of one layer. */
+  /**
+   * The colour at a document pixel: of the composite or of one layer. The composite includes the
+   * paper unless `paper` is false, so a pick where nothing is painted comes back with alpha 0.
+   */
   pickColor(x, y, options = {}) {
     const { width, height } = this.doc.canvas;
     const px = Math.floor(x);
@@ -4344,7 +4347,7 @@ var PaintEditorController = (_class10 = class _PaintEditorController {
       const [r, g, b, a] = _chunkCWM3CUUXcjs.readPixel.call(void 0, l.surface, px - l.offset.x, py - l.offset.y);
       return { color: rgbToHex(r, g, b), alpha: Math.round(a / 255 * 1e3) / 1e3 };
     }
-    const d = this.exportCompositor.composite(this.renderLayers({}), { x: px, y: py, width: 1, height: 1 }, this.sources());
+    const d = this.exportCompositor.composite(this.renderLayers({ paper: options.paper }), { x: px, y: py, width: 1, height: 1 }, this.sources());
     return { color: rgbToHex(d[0], d[1], d[2]), alpha: Math.round(d[3] / 255 * 1e3) / 1e3 };
   }
   // --- Mixer Brush ---------------------------------------------------------------
@@ -5075,11 +5078,12 @@ var PaintEditorController = (_class10 = class _PaintEditorController {
   /**
    * Composites the viewport stack (paper, view-only underlays, layers with the live stroke) tile by
    * tile over `rect`, calling `onTile` with each 256 px tile's RGBA (cached: unchanged tiles come back
-   * as the same buffer). Pass `takeDirty()` as `dirty`.
+   * as the same buffer). Pass `takeDirty()` as `dirty`. With `paper: false` the paper is left out and
+   * unpainted pixels stay transparent, for a host that draws the paint over its own surface.
    */
   compositeTiles(rect, onTile, options = {}) {
     const dirty = options.dirty === "all" ? void 0 : options.dirty;
-    this.viewCompositor.compositeTiles(this.renderLayers({}, true), rect, this.sources(), onTile, { dirty, checkpointLayerId: _nullishCoalesce(_optionalChain([this, 'access', _261 => _261.live, 'optionalAccess', _262 => _262.layerId]), () => ( this.doc.activeLayerId)) });
+    this.viewCompositor.compositeTiles(this.renderLayers({ paper: options.paper }, true), rect, this.sources(), onTile, { dirty, checkpointLayerId: _nullishCoalesce(_optionalChain([this, 'access', _261 => _261.live, 'optionalAccess', _262 => _262.layerId]), () => ( this.doc.activeLayerId)) });
   }
   /** The canvas as canvas-sized RGBA (paper included by default). */
   compositePixels(options = {}) {

package/dist/paint-editor/index.js

@@ -4332,7 +4332,10 @@ var PaintEditorController = class _PaintEditorController {
     [this.color, this.secondaryColor] = [this.secondaryColor, this.color];
     this.emit([]);
   }
-  /** The colour at a document pixel: of the composite (paper included) or of one layer. */
+  /**
+   * The colour at a document pixel: of the composite or of one layer. The composite includes the
+   * paper unless `paper` is false, so a pick where nothing is painted comes back with alpha 0.
+   */
   pickColor(x, y, options = {}) {
     const { width, height } = this.doc.canvas;
     const px = Math.floor(x);
@@ -4344,7 +4347,7 @@ var PaintEditorController = class _PaintEditorController {
       const [r, g, b, a] = readPixel(l.surface, px - l.offset.x, py - l.offset.y);
       return { color: rgbToHex(r, g, b), alpha: Math.round(a / 255 * 1e3) / 1e3 };
     }
-    const d = this.exportCompositor.composite(this.renderLayers({}), { x: px, y: py, width: 1, height: 1 }, this.sources());
+    const d = this.exportCompositor.composite(this.renderLayers({ paper: options.paper }), { x: px, y: py, width: 1, height: 1 }, this.sources());
     return { color: rgbToHex(d[0], d[1], d[2]), alpha: Math.round(d[3] / 255 * 1e3) / 1e3 };
   }
   // --- Mixer Brush ---------------------------------------------------------------
@@ -5075,11 +5078,12 @@ var PaintEditorController = class _PaintEditorController {
   /**
    * Composites the viewport stack (paper, view-only underlays, layers with the live stroke) tile by
    * tile over `rect`, calling `onTile` with each 256 px tile's RGBA (cached: unchanged tiles come back
-   * as the same buffer). Pass `takeDirty()` as `dirty`.
+   * as the same buffer). Pass `takeDirty()` as `dirty`. With `paper: false` the paper is left out and
+   * unpainted pixels stay transparent, for a host that draws the paint over its own surface.
    */
   compositeTiles(rect, onTile, options = {}) {
     const dirty = options.dirty === "all" ? void 0 : options.dirty;
-    this.viewCompositor.compositeTiles(this.renderLayers({}, true), rect, this.sources(), onTile, { dirty, checkpointLayerId: this.live?.layerId ?? this.doc.activeLayerId });
+    this.viewCompositor.compositeTiles(this.renderLayers({ paper: options.paper }, true), rect, this.sources(), onTile, { dirty, checkpointLayerId: this.live?.layerId ?? this.doc.activeLayerId });
   }
   /** The canvas as canvas-sized RGBA (paper included by default). */
   compositePixels(options = {}) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pixerate/editor",
-  "version": "0.151.0",
+  "version": "0.152.0",
   "description": "UI-agnostic rich text and media editing core library",
   "author": "Pixerate",
   "license": "MIT",