@pixerate/editor 0.186.0 → 0.188.0

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

@@ -113,6 +113,12 @@ export interface SelectionCommandOptions {
 }
 /** How the canvas shows the selection: marching ants, a Quick Mask tint, or not at all. */
 export type SelectionDisplay = 'ants' | 'quickMask' | 'none';
+/** What `exportMaskImage` writes: the selection, an alpha channel or a layer's painted mask. */
+export type MaskImageSource = 'selection' | {
+    channelId: string;
+} | {
+    layerId: string;
+};
 /** Where an AI result goes (see `applyInpaintedImage`, `applyBackgroundRemovedImage`). */
 export interface AIResultOptions {
     /** `new-layer`: a new layer (inpainting) or a mask (background removal); `replace`: the Background's pixels. Default: by `isMultiLayer`. */
@@ -718,8 +724,8 @@ export declare class ImageEditorController {
     private asOneStep;
     private recordHistory;
     /**
-     * Bytes of pixel tiles held only by undo / redo steps (not by the current state). The oldest
-     * undo steps are dropped while it exceeds `maxHistoryBytes`.
+     * Bytes of pixel, selection and channel tiles held only by undo / redo steps (not by the
+     * current state). The oldest undo steps are dropped while it exceeds `maxHistoryBytes`.
      */
     get historyBytes(): number;
     private trimHistoryBytes;
@@ -1448,6 +1454,29 @@ export declare class ImageEditorController {
         threshold?: number;
         mode?: SelectionMode;
     }): Promise<SelectionMask | null>;
+    /**
+     * Loads a mask image (a data URL / URL or RGBA pixels, any size, resampled) into a new alpha
+     * channel, read like `loadSelectionFromImage`. The selection does not change. One undo step.
+     */
+    loadChannelFromImage(source: string | PixelBuffer, options?: {
+        name?: string;
+        channel?: SelectionChannel;
+        invert?: boolean;
+        threshold?: number;
+    }): Promise<AlphaChannel>;
+    /**
+     * A full-size greyscale PNG (white = selected / revealed) of the selection, an alpha channel or
+     * a layer's painted mask, as a data URL; `invert` swaps black and white, `maxSide` scales it
+     * down. Encoded in code, so it works without a canvas. Throws when the source is missing.
+     */
+    exportMaskImage(source: MaskImageSource, options?: {
+        invert?: boolean;
+        maxSide?: number;
+    }): {
+        width: number;
+        height: number;
+        dataUrl: string;
+    };
     /** A mask image (data URL / URL, or pixels as they are) as RGBA pixels. */
     private decodeMaskImage;
     /**
@@ -1493,6 +1522,8 @@ export declare class ImageEditorController {
         name?: string;
         mode?: SelectionMode;
     }): AlphaChannel;
+    /** Appends a new channel holding `mask` (canvas-sized) as one undo step. */
+    private addChannel;
     /**
      * Select › Load Selection from an alpha channel (inverted with `invert`), combined with the
      * selection by `mode`. One undo step.
@@ -1528,7 +1559,7 @@ export declare class ImageEditorController {
     setQuickMaskMode(on: boolean): void;
     /** The selection as a 1-channel surface to paint in Quick Mask mode. */
     private quickMaskSurface;
-    /** The selection a painted Quick Mask surface stands for (`rects` changed since `base`). */
+    /** The selection a painted Quick Mask surface stands for (it shares the surface's tiles). */
     private selectionFromSurface;
     private maskFromSelection;
     /**
@@ -1546,6 +1577,8 @@ export declare class ImageEditorController {
      * with `invert`. False without a painted mask (a depth mask is computed, not painted).
      */
     selectionFromLayerMask(layerId: string, mode?: SelectionMode, invert?: boolean): boolean;
+    /** A layer's painted mask over the canvas as a selection mask; null without one (or for a depth mask). */
+    private layerMaskCoverage;
     /**
      * Histogram of the last rendered preview (after adjustments and layers, before annotations),
      * or `null` before the first render or without canvas pixel access.

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

@@ -113,6 +113,12 @@ export interface SelectionCommandOptions {
 }
 /** How the canvas shows the selection: marching ants, a Quick Mask tint, or not at all. */
 export type SelectionDisplay = 'ants' | 'quickMask' | 'none';
+/** What `exportMaskImage` writes: the selection, an alpha channel or a layer's painted mask. */
+export type MaskImageSource = 'selection' | {
+    channelId: string;
+} | {
+    layerId: string;
+};
 /** Where an AI result goes (see `applyInpaintedImage`, `applyBackgroundRemovedImage`). */
 export interface AIResultOptions {
     /** `new-layer`: a new layer (inpainting) or a mask (background removal); `replace`: the Background's pixels. Default: by `isMultiLayer`. */
@@ -718,8 +724,8 @@ export declare class ImageEditorController {
     private asOneStep;
     private recordHistory;
     /**
-     * Bytes of pixel tiles held only by undo / redo steps (not by the current state). The oldest
-     * undo steps are dropped while it exceeds `maxHistoryBytes`.
+     * Bytes of pixel, selection and channel tiles held only by undo / redo steps (not by the
+     * current state). The oldest undo steps are dropped while it exceeds `maxHistoryBytes`.
      */
     get historyBytes(): number;
     private trimHistoryBytes;
@@ -1448,6 +1454,29 @@ export declare class ImageEditorController {
         threshold?: number;
         mode?: SelectionMode;
     }): Promise<SelectionMask | null>;
+    /**
+     * Loads a mask image (a data URL / URL or RGBA pixels, any size, resampled) into a new alpha
+     * channel, read like `loadSelectionFromImage`. The selection does not change. One undo step.
+     */
+    loadChannelFromImage(source: string | PixelBuffer, options?: {
+        name?: string;
+        channel?: SelectionChannel;
+        invert?: boolean;
+        threshold?: number;
+    }): Promise<AlphaChannel>;
+    /**
+     * A full-size greyscale PNG (white = selected / revealed) of the selection, an alpha channel or
+     * a layer's painted mask, as a data URL; `invert` swaps black and white, `maxSide` scales it
+     * down. Encoded in code, so it works without a canvas. Throws when the source is missing.
+     */
+    exportMaskImage(source: MaskImageSource, options?: {
+        invert?: boolean;
+        maxSide?: number;
+    }): {
+        width: number;
+        height: number;
+        dataUrl: string;
+    };
     /** A mask image (data URL / URL, or pixels as they are) as RGBA pixels. */
     private decodeMaskImage;
     /**
@@ -1493,6 +1522,8 @@ export declare class ImageEditorController {
         name?: string;
         mode?: SelectionMode;
     }): AlphaChannel;
+    /** Appends a new channel holding `mask` (canvas-sized) as one undo step. */
+    private addChannel;
     /**
      * Select › Load Selection from an alpha channel (inverted with `invert`), combined with the
      * selection by `mode`. One undo step.
@@ -1528,7 +1559,7 @@ export declare class ImageEditorController {
     setQuickMaskMode(on: boolean): void;
     /** The selection as a 1-channel surface to paint in Quick Mask mode. */
     private quickMaskSurface;
-    /** The selection a painted Quick Mask surface stands for (`rects` changed since `base`). */
+    /** The selection a painted Quick Mask surface stands for (it shares the surface's tiles). */
     private selectionFromSurface;
     private maskFromSelection;
     /**
@@ -1546,6 +1577,8 @@ export declare class ImageEditorController {
      * with `invert`. False without a painted mask (a depth mask is computed, not painted).
      */
     selectionFromLayerMask(layerId: string, mode?: SelectionMode, invert?: boolean): boolean;
+    /** A layer's painted mask over the canvas as a selection mask; null without one (or for a depth mask). */
+    private layerMaskCoverage;
     /**
      * Histogram of the last rendered preview (after adjustments and layers, before annotations),
      * or `null` before the first render or without canvas pixel access.