@pixerate/editor 0.239.0 → 0.241.0

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

@@ -24,12 +24,59 @@ export interface PaintEffectPaint {
     values: Record<string, EffectValue>;
     /** Which moment of an animated effect, in ms. */
     time: number;
+    /**
+     * How the effect lies on the paint: fixed to the canvas (missing, the default), or along each
+     * stroke (`by: 'stroke'`): the effect is rendered as a strip `length` px long and 256 px across,
+     * and each pixel takes the colour at (distance along the stroke, position across the tip).
+     */
+    map?: PaintEffectStrokeMap;
+    /**
+     * Live: on a stroke layer the stroke keeps playing the effect (each frame drawn at the editor's
+     * effect time); elsewhere it bakes the frame at `time` like any effect paint.
+     */
+    live?: boolean;
 }
-/** Canvas-sized straight-alpha RGBA an effect paint was rendered to. */
+/** Effect paint laid along the stroke. */
+export interface PaintEffectStrokeMap {
+    by: 'stroke';
+    /** Strip length: px of stroke per repeat of the effect, 16..4096. */
+    length: number;
+    /** Past the strip's end: start again, run back (mirror), or hold the last colour (clamp). */
+    repeat: 'repeat' | 'mirror' | 'clamp';
+}
+/** How tall a stroke-mapped effect strip is rendered (the position across the tip maps onto it). */
+export declare const EFFECT_STRIP_HEIGHT = 256;
+export declare const EFFECT_MAP_REPEATS: readonly ["repeat", "mirror", "clamp"];
+/** The size an effect paint renders at: the canvas, or its strip. */
+export declare function effectPaintSize(p: PaintEffectPaint, canvas: {
+    width: number;
+    height: number;
+}): {
+    width: number;
+    height: number;
+};
+/** A stroke map checked and rounded; throws a sentence naming the bad field. */
+export declare function readEffectStrokeMap(raw: unknown): PaintEffectStrokeMap | undefined;
+/**
+ * Straight-alpha RGBA an effect paint was rendered to: canvas-sized, or (with `map`) the strip
+ * laid along each stroke.
+ */
 export interface EffectPaintPixels {
     width: number;
     height: number;
     data: ArrayLike<number>;
+    map?: PaintEffectStrokeMap;
+}
+/** Where a dab is on its stroke, for effect paint laid along the stroke. */
+export interface EffectDabPlace {
+    x: number;
+    y: number;
+    /** Direction of travel, radians counter-clockwise with y up. */
+    direction: number;
+    /** The tip's radius (px): the position across the tip maps onto the strip's height. */
+    radius: number;
+    /** Path length (px) travelled to the dab. */
+    travel: number;
 }
 /** The cache key of an effect paint (the same source renders the same pixels). */
 export declare function effectPaintKey(p: PaintEffectPaint): string;
@@ -42,6 +89,16 @@ export declare function readPaintEffectPaint(raw: unknown): PaintEffectPaint | n
  * document rectangle) with the effect's colour at each pixel and multiplies `vals` by its alpha.
  * Pixels off the canvas paint nothing.
  */
-export declare function sampleEffectField(img: EffectPaintPixels, rect: RasterRect, vals: Float32Array, field: Float32Array): void;
+export declare function sampleEffectField(img: EffectPaintPixels, rect: RasterRect, vals: Float32Array, field: Float32Array, dab?: EffectDabPlace | null): void;
 /** The effect's colour (sRGB 0..1 into `out`) at a document point; returns its alpha 0..1 (0 off the canvas). */
-export declare function sampleEffectAt(img: EffectPaintPixels, x: number, y: number, out: [number, number, number]): number;
+export declare function sampleEffectAt(img: EffectPaintPixels, x: number, y: number, out: [number, number, number], dab?: EffectDabPlace | null): number;
+/**
+ * Effect colours for one dab of a brush that mixes paint (wet and impasto brushes): fills `field`
+ * (sRGB 0..1, 3 per pixel of `rect`) with the effect's colour at each pixel, shifted by how far the
+ * brush's mixed paint (`mixed`) moved from the effect's colour at the dab's centre (`centre`, which
+ * the brush was loaded with), so paint the brush picked up still drags through the pattern. A clean
+ * brush paints the effect's colours exactly. `cov` is multiplied by the effect's alpha, rounded to
+ * `steps` levels when given (wet paint keeps its coverage on fixed steps so replays are exact).
+ * `dab` places it on its stroke, for effect paint laid along the stroke.
+ */
+export declare function effectDabField(img: EffectPaintPixels, rect: RasterRect, cov: Float32Array, centre: readonly [number, number, number], mixed: readonly [number, number, number], field: Float32Array, steps?: number, dab?: EffectDabPlace | null): void;