@pixerate/editor 0.209.0 → 0.210.0

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

@@ -488,6 +488,31 @@ export interface ContentAwareFillOptions {
     sampleRadius?: number;
     /** Random seed: the same seed gives the same fill (default 0). */
     seed?: number;
+    /**
+     * Where the fill may copy from (natural pixels), instead of the automatic ring around the
+     * selection: a mask (the Content-Aware Fill workspace's painted area), an alpha channel, or
+     * rectangles. `excludeRects` are never copied from, whichever way the area is given.
+     */
+    samplingArea?: SelectionMask | null;
+    samplingChannelId?: string;
+    sampleRects?: CropBox[];
+    excludeRects?: CropBox[];
+}
+/** What a Content-Aware Fill works on: the selection's window of a pixel layer (see `prepareContentAwareFill`). */
+export interface ContentAwareFillPlan {
+    layerId: string;
+    /** The window it fills and samples in (document pixels). */
+    window: CropBox;
+    /** The selection's bounds. */
+    bounds: CropBox;
+    /** The layer's pixels in the window, RGBA. */
+    before: Uint8ClampedArray;
+    /** 1 where the selection covers (the hole), per window pixel. */
+    hole: Uint8Array;
+    /** The selection's coverage 0..255 per window pixel. */
+    coverage: Uint8Array;
+    /** 1 where the fill may not copy from, per window pixel (null: everywhere outside the hole). */
+    exclude: Uint8Array | null;
 }
 /** Pixels on the editor's clipboard: RGBA, and where they were copied from (document pixels). */
 export interface ClipboardImage extends PixelBuffer {
@@ -1452,13 +1477,47 @@ export declare class ImageEditorController {
      * (PatchMatch, as the Spot Healing Brush's content-aware mode), blended by the selection's
      * coverage. `output` `current` paints into the layer; `new-layer` puts the fill on a new layer
      * above it. Samples within `sampleRadius` px of the selection (default its larger side, at
-     * least 32). Deterministic for a `seed`. One undo step. 8-bit documents only for now.
+     * least 32), or from the given sampling area. Deterministic for a `seed`. One undo step.
+     * 8-bit documents only for now. Runs here; see `contentAwareFillAsync` for the worker.
      */
     contentAwareFill(options?: ContentAwareFillOptions): {
         layerId: string;
         bounds: CropBox;
         output: 'current' | 'new-layer';
     };
+    /**
+     * `contentAwareFill` with the synthesis in the selection worker when there is one, with
+     * `signal` and `onProgress`. The layer is checked again before the result lands.
+     */
+    contentAwareFillAsync(options?: ContentAwareFillOptions & {
+        signal?: AbortSignal;
+        onProgress?: SelectionProgress;
+    }): Promise<{
+        layerId: string;
+        bounds: CropBox;
+        output: 'current' | 'new-layer';
+    }>;
+    /**
+     * The fill without changing anything: the window, its pixels before and after (RGBA, the fill
+     * blended by the selection's coverage) and the sampling area used, for a preview.
+     */
+    previewContentAwareFill(options?: ContentAwareFillOptions & {
+        signal?: AbortSignal;
+        onProgress?: SelectionProgress;
+    }): Promise<{
+        plan: ContentAwareFillPlan;
+        after: Uint8ClampedArray;
+    }>;
+    private synthesiseFill;
+    /**
+     * Checks and gathers what a Content-Aware Fill needs: the selection, the 8-bit pixel layer, the
+     * window around the selection (and the sampling area), and which pixels it may copy from.
+     */
+    prepareContentAwareFill(options?: ContentAwareFillOptions): ContentAwareFillPlan;
+    /** The window's pixels with `filled` blended in by the coverage (`current`), or the fill alone, its alpha by the coverage (`new-layer`). */
+    private blendFill;
+    /** Puts a computed fill into the document as one undo step. */
+    private applyContentAwareFill;
     /** The pixel clipboard (Copy / Cut), or null. */
     private clipboard;
     /** What Copy or Cut last put on the editor's clipboard, or null. */

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

@@ -488,6 +488,31 @@ export interface ContentAwareFillOptions {
     sampleRadius?: number;
     /** Random seed: the same seed gives the same fill (default 0). */
     seed?: number;
+    /**
+     * Where the fill may copy from (natural pixels), instead of the automatic ring around the
+     * selection: a mask (the Content-Aware Fill workspace's painted area), an alpha channel, or
+     * rectangles. `excludeRects` are never copied from, whichever way the area is given.
+     */
+    samplingArea?: SelectionMask | null;
+    samplingChannelId?: string;
+    sampleRects?: CropBox[];
+    excludeRects?: CropBox[];
+}
+/** What a Content-Aware Fill works on: the selection's window of a pixel layer (see `prepareContentAwareFill`). */
+export interface ContentAwareFillPlan {
+    layerId: string;
+    /** The window it fills and samples in (document pixels). */
+    window: CropBox;
+    /** The selection's bounds. */
+    bounds: CropBox;
+    /** The layer's pixels in the window, RGBA. */
+    before: Uint8ClampedArray;
+    /** 1 where the selection covers (the hole), per window pixel. */
+    hole: Uint8Array;
+    /** The selection's coverage 0..255 per window pixel. */
+    coverage: Uint8Array;
+    /** 1 where the fill may not copy from, per window pixel (null: everywhere outside the hole). */
+    exclude: Uint8Array | null;
 }
 /** Pixels on the editor's clipboard: RGBA, and where they were copied from (document pixels). */
 export interface ClipboardImage extends PixelBuffer {
@@ -1452,13 +1477,47 @@ export declare class ImageEditorController {
      * (PatchMatch, as the Spot Healing Brush's content-aware mode), blended by the selection's
      * coverage. `output` `current` paints into the layer; `new-layer` puts the fill on a new layer
      * above it. Samples within `sampleRadius` px of the selection (default its larger side, at
-     * least 32). Deterministic for a `seed`. One undo step. 8-bit documents only for now.
+     * least 32), or from the given sampling area. Deterministic for a `seed`. One undo step.
+     * 8-bit documents only for now. Runs here; see `contentAwareFillAsync` for the worker.
      */
     contentAwareFill(options?: ContentAwareFillOptions): {
         layerId: string;
         bounds: CropBox;
         output: 'current' | 'new-layer';
     };
+    /**
+     * `contentAwareFill` with the synthesis in the selection worker when there is one, with
+     * `signal` and `onProgress`. The layer is checked again before the result lands.
+     */
+    contentAwareFillAsync(options?: ContentAwareFillOptions & {
+        signal?: AbortSignal;
+        onProgress?: SelectionProgress;
+    }): Promise<{
+        layerId: string;
+        bounds: CropBox;
+        output: 'current' | 'new-layer';
+    }>;
+    /**
+     * The fill without changing anything: the window, its pixels before and after (RGBA, the fill
+     * blended by the selection's coverage) and the sampling area used, for a preview.
+     */
+    previewContentAwareFill(options?: ContentAwareFillOptions & {
+        signal?: AbortSignal;
+        onProgress?: SelectionProgress;
+    }): Promise<{
+        plan: ContentAwareFillPlan;
+        after: Uint8ClampedArray;
+    }>;
+    private synthesiseFill;
+    /**
+     * Checks and gathers what a Content-Aware Fill needs: the selection, the 8-bit pixel layer, the
+     * window around the selection (and the sampling area), and which pixels it may copy from.
+     */
+    prepareContentAwareFill(options?: ContentAwareFillOptions): ContentAwareFillPlan;
+    /** The window's pixels with `filled` blended in by the coverage (`current`), or the fill alone, its alpha by the coverage (`new-layer`). */
+    private blendFill;
+    /** Puts a computed fill into the document as one undo step. */
+    private applyContentAwareFill;
     /** The pixel clipboard (Copy / Cut), or null. */
     private clipboard;
     /** What Copy or Cut last put on the editor's clipboard, or null. */