@pixerate/editor 0.276.0 → 0.277.0

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

@@ -114,6 +114,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 +155,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 +196,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

@@ -114,6 +114,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 +155,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 +196,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/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;