@pixerate/editor 0.272.1 → 0.273.0

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

@@ -18,6 +18,7 @@ import { type LayerLocks } from '../raster/layers.js';
 import { type LayerEffect, type LayerEffectKind, type LayerEffects } from '../raster/effects/model.js';
 import type { EffectPattern } from '../raster/effects/patterns.js';
 import { TiledSurface, type RasterRect, type Tile } from '../raster/surface.js';
+import { type FillRegionPoint, type FillRegionSummary, type UnfilledRegion } from '../raster/fill.js';
 import { type PaintBrushInput, type PaintBrush } from './brushes.js';
 import { type BrushLibrary, type BrushLibraryFile } from '../brushes/library.js';
 import { type BrushPatch, type UnsettableBrushFacet } from '../brushes/patch.js';
@@ -297,6 +298,75 @@ export interface FillLayerOptions {
     pressure?: number;
     blend?: BlendMode;
 }
+export type FillReference = 'layer' | 'all' | 'composite' | (string & {});
+export interface FillRegionOptions {
+    /** Seed x in document pixels (pass `x` and `y`, or `points`). */
+    x?: number;
+    /** Seed y in document pixels (pass `x` and `y`, or `points`). */
+    y?: number;
+    /** Multiple seed points in document pixels (filled together as one undo step). */
+    points?: ReadonlyArray<FillRegionPoint>;
+    /** Target layer id from `listLayers` (default the active layer). */
+    layerId?: string;
+    /**
+     * Which pixels define the region boundaries:
+     * - `'layer'` (default): the target layer itself.
+     * - `'all'` or `'composite'`: all visible layers composited (without paper).
+     * - a layer id from `listLayers`: that layer (e.g. an ink line-art layer above a flats layer).
+     */
+    reference?: FillReference;
+    /** Fill colour #rrggbb (default the editor's paint colour). */
+    color?: string;
+    /** Opacity 0..1 (default 1). */
+    opacity?: number;
+    /** Blend mode (default `'normal'`). */
+    blend?: BlendMode;
+    /** Alias for `blend`. */
+    blendMode?: BlendMode;
+    /** Colour/alpha similarity tolerance 0..255 (default 32). */
+    tolerance?: number;
+    /** Close small gaps in line art up to this width in pixels, 0..32 (default 0). */
+    closeGap?: number;
+    /** Expand (> 0, bleed under lines) or contract (< 0) the filled region in pixels, -16..16 (default 0). */
+    expand?: number;
+    /** Soften boundary edges (default true). */
+    antialias?: boolean;
+    /** Paper grain response 0..1 (default 0: flat fill). */
+    grain?: number;
+    /** With grain: pressure 0..1, how far the fill reaches into the valleys (default 0.5). */
+    pressure?: number;
+    /** Pour a wet watercolour wash into the region on the layer's wet layer (default false). */
+    wet?: boolean;
+}
+export interface FillRegionResult {
+    layerId: string;
+    bounds: RasterRect | null;
+    pixelCount: number;
+    leaked: boolean;
+    regions: FillRegionSummary[];
+    wet?: boolean;
+}
+export interface FindUnfilledRegionsOptions {
+    /** Target layer id from `listLayers` (when given, regions already painted on it are excluded). */
+    layerId?: string;
+    /**
+     * Which pixels define the line-art barriers:
+     * - `'all'` or `'composite'` (default): all visible layers composited (without paper).
+     * - `'layer'`: the target (or active) layer itself.
+     * - a layer id from `listLayers`: that layer (e.g. an ink line-art layer).
+     */
+    reference?: FillReference;
+    /** Alpha/colour threshold 0..255 above which a reference pixel is treated as line art (default 32). */
+    tolerance?: number;
+    /** Close small gaps in line art up to this width in pixels, 0..32 (default 0). */
+    closeGap?: number;
+    /** Ignore regions smaller than this many pixels (default 16). */
+    minArea?: number;
+    /** Include regions that touch the canvas border (default false: only enclosed shapes). */
+    includeEdge?: boolean;
+    /** Maximum number of regions to return, sorted largest first (default 100). */
+    maxRegions?: number;
+}
 /** Pixels to add on each side of the canvas (whole numbers, 0 or more; missing = 0). */
 export interface PaintCanvasExtension {
     left?: number;
@@ -653,6 +723,22 @@ export declare class PaintEditorController {
         layerId: string;
         bounds: RasterRect;
     };
+    /**
+     * Flood-fills one or more contiguous regions on a pixel layer (one undo step), sampling boundaries
+     * from the layer itself (`reference: 'layer'`), all visible layers (`'all'` / `'composite'`), or a
+     * specific reference layer id (e.g. an ink line-art layer above a flats layer). Closes line-art gaps
+     * up to `closeGap` px and expands (`> 0`, bleeding under lines) or contracts (`< 0`) by `expand` px.
+     * With `wet: true`, pours a watercolour wash into the region on the layer's wet layer.
+     */
+    fillRegion(options: FillRegionOptions): FillRegionResult;
+    /**
+     * Finds enclosed unfilled regions from a reference layer or the visible composite (without paper),
+     * closing line-art gaps up to `closeGap` px and returning each region's interior seed `point`,
+     * `centroid`, `bounds`, `pixelCount`, and `touchesEdge` flag.
+     */
+    findUnfilledRegions(options?: FindUnfilledRegionsOptions): {
+        regions: UnfilledRegion[];
+    };
     private applyCoverage;
     /** The registered effects provider, or `null`. */
     get effectsProvider(): EffectProvider | null;

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

@@ -69,7 +69,7 @@ export interface PaintDocumentState {
 /** A change a replay repeats besides strokes, recorded with how many strokes came before it. */
 export interface PaintEvent {
     at: number;
-    kind: 'fill' | 'clear' | 'flatten' | 'stickers' | 'live-strokes';
+    kind: 'fill' | 'fill-region' | 'clear' | 'flatten' | 'stickers' | 'live-strokes';
     layerId: string;
     /** The fill's options (colour, opacity, grain, pressure, blend), or the layer's stickers or live strokes after an edit. */
     data?: Record<string, unknown>;

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

@@ -69,7 +69,7 @@ export interface PaintDocumentState {
 /** A change a replay repeats besides strokes, recorded with how many strokes came before it. */
 export interface PaintEvent {
     at: number;
-    kind: 'fill' | 'clear' | 'flatten' | 'stickers' | 'live-strokes';
+    kind: 'fill' | 'fill-region' | 'clear' | 'flatten' | 'stickers' | 'live-strokes';
     layerId: string;
     /** The fill's options (colour, opacity, grain, pressure, blend), or the layer's stickers or live strokes after an edit. */
     data?: Record<string, unknown>;