@pixerate/editor 0.270.0 → 0.272.0

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

@@ -25,18 +25,19 @@ export interface PaintEffectPaint {
     /** 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).
+     * How the effect lies on the paint: fixed to the canvas (missing, the default), bent along each
+     * stroke (`by: 'stroke'`: rendered as a strip `length` px long and 256 px across), or along the
+     * stroke via the effect's own path control (`by: 'path'`: the stroke's centreline in canvas
+     * pixels is passed to its `format: 'svg-path'` control).
      */
-    map?: PaintEffectStrokeMap;
+    map?: PaintEffectMap;
     /**
      * 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;
 }
-/** Effect paint laid along the stroke. */
+/** Effect paint laid along the stroke as a bent strip. */
 export interface PaintEffectStrokeMap {
     by: 'stroke';
     /** Strip length: px of stroke per repeat of the effect, 16..4096. */
@@ -44,10 +45,34 @@ export interface PaintEffectStrokeMap {
     /** Past the strip's end: start again, run back (mirror), or hold the last colour (clamp). */
     repeat: 'repeat' | 'mirror' | 'clamp';
 }
+/** Effect paint whose own path control (`format: 'svg-path'`) receives each stroke's centreline in canvas pixels. */
+export interface PaintEffectPathMap {
+    by: 'path';
+}
+export type PaintEffectMap = PaintEffectStrokeMap | PaintEffectPathMap;
 /** 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. */
+/** Maximum number of centreline points passed to a path effect control; longer strokes are resampled to this count. */
+export declare const MAX_EFFECT_PATH_POINTS = 256;
+/**
+ * The stroke's centreline as `[x0, y0, x1, y1, …]` in canvas pixels for a path control
+ * (`format: 'svg-path'`). Consecutive duplicate points are collapsed, single-point taps are doubled
+ * so path renderers receive a valid segment, and strokes longer than `maxPoints` are evenly
+ * resampled by arc length rather than refused.
+ */
+export declare function strokePathPoints(points: readonly {
+    x: number;
+    y: number;
+}[], maxPoints?: number): number[];
+/** Which control of `values` holds a path when the effect description is not at hand. */
+export declare function inferEffectPathControl(values: Record<string, EffectValue>): string;
+/** A copy of a path-mapped effect paint with the stroke's centreline written into its path control. */
+export declare function withStrokePath(paint: PaintEffectPaint, points: readonly {
+    x: number;
+    y: number;
+}[], control?: string): PaintEffectPaint;
+/** The size an effect paint renders at: the canvas, or its strip when bent along the stroke. */
 export declare function effectPaintSize(p: PaintEffectPaint, canvas: {
     width: number;
     height: number;
@@ -55,8 +80,8 @@ export declare function effectPaintSize(p: PaintEffectPaint, canvas: {
     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;
+/** A stroke or path map checked and rounded; throws a sentence naming the bad field. */
+export declare function readEffectStrokeMap(raw: unknown): PaintEffectMap | undefined;
 /**
  * Straight-alpha RGBA an effect paint was rendered to: canvas-sized, or (with `map`) the strip
  * laid along each stroke.

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

@@ -25,18 +25,19 @@ export interface PaintEffectPaint {
     /** 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).
+     * How the effect lies on the paint: fixed to the canvas (missing, the default), bent along each
+     * stroke (`by: 'stroke'`: rendered as a strip `length` px long and 256 px across), or along the
+     * stroke via the effect's own path control (`by: 'path'`: the stroke's centreline in canvas
+     * pixels is passed to its `format: 'svg-path'` control).
      */
-    map?: PaintEffectStrokeMap;
+    map?: PaintEffectMap;
     /**
      * 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;
 }
-/** Effect paint laid along the stroke. */
+/** Effect paint laid along the stroke as a bent strip. */
 export interface PaintEffectStrokeMap {
     by: 'stroke';
     /** Strip length: px of stroke per repeat of the effect, 16..4096. */
@@ -44,10 +45,34 @@ export interface PaintEffectStrokeMap {
     /** Past the strip's end: start again, run back (mirror), or hold the last colour (clamp). */
     repeat: 'repeat' | 'mirror' | 'clamp';
 }
+/** Effect paint whose own path control (`format: 'svg-path'`) receives each stroke's centreline in canvas pixels. */
+export interface PaintEffectPathMap {
+    by: 'path';
+}
+export type PaintEffectMap = PaintEffectStrokeMap | PaintEffectPathMap;
 /** 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. */
+/** Maximum number of centreline points passed to a path effect control; longer strokes are resampled to this count. */
+export declare const MAX_EFFECT_PATH_POINTS = 256;
+/**
+ * The stroke's centreline as `[x0, y0, x1, y1, …]` in canvas pixels for a path control
+ * (`format: 'svg-path'`). Consecutive duplicate points are collapsed, single-point taps are doubled
+ * so path renderers receive a valid segment, and strokes longer than `maxPoints` are evenly
+ * resampled by arc length rather than refused.
+ */
+export declare function strokePathPoints(points: readonly {
+    x: number;
+    y: number;
+}[], maxPoints?: number): number[];
+/** Which control of `values` holds a path when the effect description is not at hand. */
+export declare function inferEffectPathControl(values: Record<string, EffectValue>): string;
+/** A copy of a path-mapped effect paint with the stroke's centreline written into its path control. */
+export declare function withStrokePath(paint: PaintEffectPaint, points: readonly {
+    x: number;
+    y: number;
+}[], control?: string): PaintEffectPaint;
+/** The size an effect paint renders at: the canvas, or its strip when bent along the stroke. */
 export declare function effectPaintSize(p: PaintEffectPaint, canvas: {
     width: number;
     height: number;
@@ -55,8 +80,8 @@ export declare function effectPaintSize(p: PaintEffectPaint, canvas: {
     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;
+/** A stroke or path map checked and rounded; throws a sentence naming the bad field. */
+export declare function readEffectStrokeMap(raw: unknown): PaintEffectMap | undefined;
 /**
  * Straight-alpha RGBA an effect paint was rendered to: canvas-sized, or (with `map`) the strip
  * laid along each stroke.

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

@@ -80,6 +80,10 @@ export declare class PaintEffectsRenderer {
         width: number;
         height: number;
     }, request: EffectRenderRequest): Promise<EffectPixels>;
+    renderSync(provider: EffectProvider, id: string, size: {
+        width: number;
+        height: number;
+    }, request: EffectRenderRequest): EffectPixels | null;
     dispose(): void;
 }
 /** A saved effect source, or `null` when it is not one. */

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

@@ -80,6 +80,10 @@ export declare class PaintEffectsRenderer {
         width: number;
         height: number;
     }, request: EffectRenderRequest): Promise<EffectPixels>;
+    renderSync(provider: EffectProvider, id: string, size: {
+        width: number;
+        height: number;
+    }, request: EffectRenderRequest): EffectPixels | null;
     dispose(): void;
 }
 /** A saved effect source, or `null` when it is not one. */