@pixerate/editor 0.276.0 → 0.278.0

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

@@ -59,7 +59,9 @@ export interface SerializeOptions {
 }
 /** The document as JSON with inline PNG data URLs. */
 export declare function serializePaintDocument(state: PaintDocumentState, options?: SerializeOptions): SerializedPaintDocument;
-/** The document as JSON with each PNG uploaded to `store` once (by content). */
+/** How an extension field refers to a PNG in `assets`: `asset:<asset id>`. */
+export declare const EXTENSION_ASSET_REF = "asset:";
+/** The document as JSON with each PNG (layers and extension fields alike) uploaded to `store` once (by content). */
 export declare function serializePaintDocumentExternal(state: PaintDocumentState, store: PaintAssetStore, options?: SerializeOptions): Promise<SerializedPaintDocument>;
 export interface LoadedPaintDocument {
     state: PaintDocumentState;

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

@@ -59,7 +59,9 @@ export interface SerializeOptions {
 }
 /** The document as JSON with inline PNG data URLs. */
 export declare function serializePaintDocument(state: PaintDocumentState, options?: SerializeOptions): SerializedPaintDocument;
-/** The document as JSON with each PNG uploaded to `store` once (by content). */
+/** How an extension field refers to a PNG in `assets`: `asset:<asset id>`. */
+export declare const EXTENSION_ASSET_REF = "asset:";
+/** The document as JSON with each PNG (layers and extension fields alike) uploaded to `store` once (by content). */
 export declare function serializePaintDocumentExternal(state: PaintDocumentState, store: PaintAssetStore, options?: SerializeOptions): Promise<SerializedPaintDocument>;
 export interface LoadedPaintDocument {
     state: PaintDocumentState;

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

@@ -22,6 +22,7 @@ import { type PaperGrain } from './paper.cjs';
 import { type Sticker } from './stickers.cjs';
 import type { StickerArtLookup } from './sticker-art.cjs';
 import type { StickerRef, StickerVariant } from '../stickers/types.cjs';
+import type { DualColor } from '../color/dual.cjs';
 export interface StrokeSessionHost {
     /** Shows the layer's live surface (no history); `rects` are where it changed. */
     update(layerId: string, surface: TiledSurface, rects: RasterRect[]): void;
@@ -48,6 +49,8 @@ export interface StrokeSessionInit {
     seed: number;
     /** The paint colour as #rrggbb (recorded with the stroke). */
     colorHex: string;
+    /** The light / dark pair `colorHex` is one side of, when the colour came from one (recorded with the stroke). */
+    dualColor?: DualColor;
     /** The stroke's extra copies as affine maps (recorded with the stroke); `copies` holds all of them as engine copies. */
     affineCopies: readonly Affine[];
     copies: readonly StrokeCopy[];
@@ -114,6 +117,13 @@ export interface StrokeSessionInit {
     thermo?: {
         surface: TiledSurface;
     } | null;
+    /**
+     * Ferrofluid paint: the layer's ferrofluid channel before the stroke. With it, a twin of the
+     * stroke paints the ferrofluid channel as grey (see `ferro.ts`); `ferroChannel()` returns the result.
+     */
+    ferro?: {
+        surface: TiledSurface;
+    } | null;
 }
 export interface PaintStrokeResult {
     layerId: string;
@@ -148,6 +158,9 @@ export declare class PaintStrokeSession {
     /** Light paint: the stroke's twin over the light channel, and what it left there. */
     private readonly lightTwin;
     private lightResult;
+    /** Ferrofluid paint: the stroke's twin over the ferrofluid channel, and what it left there. */
+    private readonly ferroTwin;
+    private ferroResult;
     /** UV-fluorescent ink: the stroke's twin over the fluorescence channel, and what it left there. */
     private readonly fluorTwin;
     private fluorResult;
@@ -186,6 +199,10 @@ export declare class PaintStrokeSession {
     fluorChannel(): TiledSurface | null;
     /** Thermochromic ink: the layer's thermochromic channel after the stroke, or `null` when unchanged. */
     thermoChannel(): TiledSurface | null;
+    /** The stroke's twin over the ferrofluid channel: the same marks in grey at the brush's ferro amount (see `ferro.ts`). */
+    private makeFerroTwin;
+    /** Ferrofluid paint: the layer's ferrofluid channel after the stroke, or `null` when the stroke has no twin or left it unchanged. */
+    ferroChannel(): TiledSurface | null;
     private tileTarget;
     get open(): boolean;
     /** Adds raw pen samples (document pixels). */

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

@@ -22,6 +22,7 @@ import { type PaperGrain } from './paper.js';
 import { type Sticker } from './stickers.js';
 import type { StickerArtLookup } from './sticker-art.js';
 import type { StickerRef, StickerVariant } from '../stickers/types.js';
+import type { DualColor } from '../color/dual.js';
 export interface StrokeSessionHost {
     /** Shows the layer's live surface (no history); `rects` are where it changed. */
     update(layerId: string, surface: TiledSurface, rects: RasterRect[]): void;
@@ -48,6 +49,8 @@ export interface StrokeSessionInit {
     seed: number;
     /** The paint colour as #rrggbb (recorded with the stroke). */
     colorHex: string;
+    /** The light / dark pair `colorHex` is one side of, when the colour came from one (recorded with the stroke). */
+    dualColor?: DualColor;
     /** The stroke's extra copies as affine maps (recorded with the stroke); `copies` holds all of them as engine copies. */
     affineCopies: readonly Affine[];
     copies: readonly StrokeCopy[];
@@ -114,6 +117,13 @@ export interface StrokeSessionInit {
     thermo?: {
         surface: TiledSurface;
     } | null;
+    /**
+     * Ferrofluid paint: the layer's ferrofluid channel before the stroke. With it, a twin of the
+     * stroke paints the ferrofluid channel as grey (see `ferro.ts`); `ferroChannel()` returns the result.
+     */
+    ferro?: {
+        surface: TiledSurface;
+    } | null;
 }
 export interface PaintStrokeResult {
     layerId: string;
@@ -148,6 +158,9 @@ export declare class PaintStrokeSession {
     /** Light paint: the stroke's twin over the light channel, and what it left there. */
     private readonly lightTwin;
     private lightResult;
+    /** Ferrofluid paint: the stroke's twin over the ferrofluid channel, and what it left there. */
+    private readonly ferroTwin;
+    private ferroResult;
     /** UV-fluorescent ink: the stroke's twin over the fluorescence channel, and what it left there. */
     private readonly fluorTwin;
     private fluorResult;
@@ -186,6 +199,10 @@ export declare class PaintStrokeSession {
     fluorChannel(): TiledSurface | null;
     /** Thermochromic ink: the layer's thermochromic channel after the stroke, or `null` when unchanged. */
     thermoChannel(): TiledSurface | null;
+    /** The stroke's twin over the ferrofluid channel: the same marks in grey at the brush's ferro amount (see `ferro.ts`). */
+    private makeFerroTwin;
+    /** Ferrofluid paint: the layer's ferrofluid channel after the stroke, or `null` when the stroke has no twin or left it unchanged. */
+    ferroChannel(): TiledSurface | null;
     private tileTarget;
     get open(): boolean;
     /** Adds raw pen samples (document pixels). */

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

@@ -14,6 +14,7 @@ import type { MixerLoad } from '../paint/exchange.cjs';
 import { type Stencil } from './stencils.cjs';
 import { type PaintGradientSource } from '../paint/gradient-paint.cjs';
 import { type PaintEffectPaint } from './effect-paint.cjs';
+import { type DualColor } from '../color/dual.cjs';
 /** An affine map [a, b, c, d, e, f]: (x, y) → (a·x + b·y + e, c·x + d·y + f). */
 export type Affine = readonly [number, number, number, number, number, number];
 export declare const IDENTITY_AFFINE: Affine;
@@ -21,8 +22,17 @@ export interface RecordedStroke {
     id: string;
     layerId: string;
     brush: PaintBrush;
-    /** #rrggbb */
+    /**
+     * #rrggbb: the colour the document draws the stroke with. A dual-colour stroke on a stroke layer
+     * keeps its light side here, whoever painted it; on a pixel layer, the side it was painted in.
+     */
     color: string;
+    /**
+     * The light / dark pair the colour came from (both #rrggbb), when it came from one. A stroke
+     * layer shows it in the viewer's side (`PaintEditorController.setColorScheme`) without changing
+     * the document; a pixel layer's pixels stay as painted.
+     */
+    dualColor?: DualColor;
     /** Raw pen samples in document pixels, before smoothing. */
     points: PenPoint[];
     seed: number;

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

@@ -14,6 +14,7 @@ import type { MixerLoad } from '../paint/exchange.js';
 import { type Stencil } from './stencils.js';
 import { type PaintGradientSource } from '../paint/gradient-paint.js';
 import { type PaintEffectPaint } from './effect-paint.js';
+import { type DualColor } from '../color/dual.js';
 /** An affine map [a, b, c, d, e, f]: (x, y) → (a·x + b·y + e, c·x + d·y + f). */
 export type Affine = readonly [number, number, number, number, number, number];
 export declare const IDENTITY_AFFINE: Affine;
@@ -21,8 +22,17 @@ export interface RecordedStroke {
     id: string;
     layerId: string;
     brush: PaintBrush;
-    /** #rrggbb */
+    /**
+     * #rrggbb: the colour the document draws the stroke with. A dual-colour stroke on a stroke layer
+     * keeps its light side here, whoever painted it; on a pixel layer, the side it was painted in.
+     */
     color: string;
+    /**
+     * The light / dark pair the colour came from (both #rrggbb), when it came from one. A stroke
+     * layer shows it in the viewer's side (`PaintEditorController.setColorScheme`) without changing
+     * the document; a pixel layer's pixels stay as painted.
+     */
+    dualColor?: DualColor;
     /** Raw pen samples in document pixels, before smoothing. */
     points: PenPoint[];
     seed: number;

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

@@ -20,6 +20,7 @@ import { TiledSurface, type RasterRect } from '../raster/surface.cjs';
 import type { IridescenceSettings } from './brush-model.cjs';
 import type { PaintBrush } from './brushes.cjs';
 import { type PenPoint, type StrokeCopy } from './engine.cjs';
+import { type FerroLayerInput } from './ferro.cjs';
 /** Where the light comes from. */
 export interface PaintLighting {
     /** Degrees clockwise from the top of the canvas (315: top left, the default). */
@@ -66,8 +67,20 @@ export declare function lightTile(color: Uint8ClampedArray, height: Uint8Clamped
 /** Cache of lit tiles for one layer, by the identity of their inputs. */
 export declare class LitCache {
     private readonly tiles;
-    /** The layer's pixels lit (tiles without relief or film nearby are the colour tiles themselves). */
-    lit(color: TiledSurface, ch: ThickChannels, light: PaintLighting, viewTilt?: PaintViewTilt): TiledSurface;
+    /**
+     * The layer's pixels lit (tiles without relief, film or ferrofluid nearby are the colour tiles
+     * themselves). Without ferrofluid this is the thick-paint / thin-film pass; with it, the liquid
+     * ferrofluid adds its carrier colour, glossy metallic material and (near magnets) Rosensweig
+     * spike heights before the same lighting.
+     */
+    lit(color: TiledSurface, ch: ThickChannels, light: PaintLighting, viewTilt?: PaintViewTilt, ferro?: FerroLayerInput | null): TiledSurface;
+    /**
+     * The ferrofluid lighting pass: every tile with ferrofluid or thick relief nearby is lit, with the
+     * liquid's carrier colour and gloss / metal material blended in and its spikes added to the
+     * height field. Thick relief is lit even when `light.relief` is 0 here (the spikes need it), and
+     * a thin film on the same layer still colours the lit tiles.
+     */
+    private litFerro;
 }
 /** Live thin-film iridescence buffer for any stroke engine (deposits or erases into 4-channel `ThickChannels.film`). */
 export declare class FilmBuffer {

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

@@ -20,6 +20,7 @@ import { TiledSurface, type RasterRect } from '../raster/surface.js';
 import type { IridescenceSettings } from './brush-model.js';
 import type { PaintBrush } from './brushes.js';
 import { type PenPoint, type StrokeCopy } from './engine.js';
+import { type FerroLayerInput } from './ferro.js';
 /** Where the light comes from. */
 export interface PaintLighting {
     /** Degrees clockwise from the top of the canvas (315: top left, the default). */
@@ -66,8 +67,20 @@ export declare function lightTile(color: Uint8ClampedArray, height: Uint8Clamped
 /** Cache of lit tiles for one layer, by the identity of their inputs. */
 export declare class LitCache {
     private readonly tiles;
-    /** The layer's pixels lit (tiles without relief or film nearby are the colour tiles themselves). */
-    lit(color: TiledSurface, ch: ThickChannels, light: PaintLighting, viewTilt?: PaintViewTilt): TiledSurface;
+    /**
+     * The layer's pixels lit (tiles without relief, film or ferrofluid nearby are the colour tiles
+     * themselves). Without ferrofluid this is the thick-paint / thin-film pass; with it, the liquid
+     * ferrofluid adds its carrier colour, glossy metallic material and (near magnets) Rosensweig
+     * spike heights before the same lighting.
+     */
+    lit(color: TiledSurface, ch: ThickChannels, light: PaintLighting, viewTilt?: PaintViewTilt, ferro?: FerroLayerInput | null): TiledSurface;
+    /**
+     * The ferrofluid lighting pass: every tile with ferrofluid or thick relief nearby is lit, with the
+     * liquid's carrier colour and gloss / metal material blended in and its spikes added to the
+     * height field. Thick relief is lit even when `light.relief` is 0 here (the spikes need it), and
+     * a thin film on the same layer still colours the lit tiles.
+     */
+    private litFerro;
 }
 /** Live thin-film iridescence buffer for any stroke engine (deposits or erases into 4-channel `ThickChannels.film`). */
 export declare class FilmBuffer {

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

@@ -302,6 +302,8 @@ export declare const STROKE_SLIDERS: readonly SliderControl[];
 export declare const STICKER_SLIDERS: readonly SliderControl[];
 /** The evolution panel's mutation sliders (`0..1`). */
 export declare const EVOLUTION_SLIDERS: readonly SliderControl[];
+/** The ferrofluid panel's sliders for a magnet (`strength` and `radius`). */
+export declare const MAGNET_SLIDERS: readonly SliderControl[];
 /** Stencils a toolbar can lay with one click, centred on the canvas. */
 export declare function quickStencil(kind: 'ruler' | 'circle' | 'ellipse-mask' | 'edge-mask', canvas: {
     width: number;

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

@@ -302,6 +302,8 @@ export declare const STROKE_SLIDERS: readonly SliderControl[];
 export declare const STICKER_SLIDERS: readonly SliderControl[];
 /** The evolution panel's mutation sliders (`0..1`). */
 export declare const EVOLUTION_SLIDERS: readonly SliderControl[];
+/** The ferrofluid panel's sliders for a magnet (`strength` and `radius`). */
+export declare const MAGNET_SLIDERS: readonly SliderControl[];
 /** Stencils a toolbar can lay with one click, centred on the canvas. */
 export declare function quickStencil(kind: 'ruler' | 'circle' | 'ellipse-mask' | 'edge-mask', canvas: {
     width: number;