pixi-effects 0.1.0 → 0.3.0

package/dist/{Movie-Bp66rkaC.d.cts → types-3c8Vymgw.d.cts}

@@ -1,6 +1,3 @@
-import { Application } from 'pixi.js';
-import { gsap } from 'gsap';
-
 /**
  * pixi-effects public DSL types.
  *
@@ -16,9 +13,21 @@ type PropValue = number | string;
 type Props = Record<string, PropValue>;
 /** A single keyframe entry. Either `set`, `to`, `from`, or `from`+`to` is meaningful per kind. */
 interface Keyframe {
+    /**
+     * Start time in seconds, measured from the start of the sequence this
+     * keyframe belongs to (After Effects style): `0` = the moment the layer
+     * appears. Negative values count back from the sequence's end
+     * (`-0.5` = 0.5 s before it ends).
+     */
     at?: number;
     duration?: number;
     ease?: string;
+    /** Extra plays of this tween after the first (a finite count; infinite repeats are not allowed — the timeline needs a fixed length). Total time = duration × (repeat + 1) plus delays. */
+    repeat?: number;
+    /** With `repeat`: every other play runs backwards (there-and-back). */
+    yoyo?: boolean;
+    /** With `repeat`: seconds to wait between plays. */
+    repeatDelay?: number;
     set?: Props;
     to?: Props;
     from?: Props;
@@ -66,7 +75,7 @@ interface TransitionCommon {
     from: string;
     /** Sibling sequence's `name` — the incoming scene. Must be declared after `from` in the parent's `sequences[]`. */
     to: string;
-    /** Start time (parent-relative seconds). Same `at` semantics as Keyframe. */
+    /** Start time in the PARENT composition's time (like a sequence's `at`, not sequence-local). Negative = back from the parent's end. */
     at: number;
     /** Length of the transition in seconds. Must be > 0. */
     duration: number;
@@ -130,10 +139,11 @@ interface SequenceCommon {
     filters?: FilterSpec[];
     /**
      * Override PIXI's auto-computed filter region. By default, filters apply
-     * only inside the target's bounding box. Setting this to a parent-relative
-     * rectangle lets a filter (e.g. a wipe / iris transition) draw across an
-     * area larger than the sprite — useful when the sprite content is small
-     * but the visual effect should cover the whole composition.
+     * only inside the target's bounding box. This rectangle is in the layer's
+     * OWN coordinate space (origin = the layer's local origin, before its
+     * x/y/scale/rotation — e.g. a circle's centre), not the parent's. Use it to
+     * let a filter (blur, glow, a wipe / iris transition) draw beyond the
+     * layer's own bounds; without it a blur is clipped to the bounding box.
      */
     filterArea?: {
         x: number;
@@ -164,6 +174,13 @@ interface SequenceCommon {
      * Routed through PIXI's native `setMask({ inverse: true })`.
      */
     maskInverted?: boolean;
+    /**
+     * Opt this layer into 2.5D: it can then use `z`, `rotationX`, `rotationY`
+     * (in `initial` / keyframes) and is projected through the composition's
+     * `camera` layer. Default false. With z = 0, no 3D rotation and the default
+     * camera, a threeD layer renders exactly like a 2D one.
+     */
+    threeD?: boolean;
 }
 interface VideoSequenceSpec extends SequenceCommon {
     type: 'video';
@@ -185,7 +202,17 @@ interface ImageSequenceSpec extends SequenceCommon {
 }
 interface TextSequenceSpec extends SequenceCommon {
     type: 'text';
+    /**
+     * The text. May contain `{value}`, replaced by the layer's animatable number
+     * `value` (a counter): `text: '{value} users'`, `initial: { value: 0 }`,
+     * keyframe `to: { value: 2480 }`. Format it with `format`.
+     */
     text?: string;
+    /** How `{value}` is printed: `decimals` (default 0) and thousands `grouping` (default false). */
+    format?: {
+        decimals?: number;
+        grouping?: boolean;
+    };
     /** Subset of PIXI v8 TextStyleOptions. String values may be exprs (e.g. fontSize: 'GW * 0.05'). */
     style?: Record<string, PropValue | {
         color?: PropValue;
@@ -212,8 +239,41 @@ interface CompositionSequenceSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
+/**
+ * A camera layer. Put its props in `initial` / `keyframes`:
+ * `x`, `y`, `z`, `lookAtX`, `lookAtY`, `lookAtZ`, `fov` (vertical degrees, default 40).
+ * Unset `z` follows `fov` so the z = 0 plane stays 1:1. Affects only `threeD`
+ * siblings in the same composition. +z points toward the viewer.
+ */
+interface CameraSequenceSpec extends SequenceCommon {
+    type: 'camera';
+}
+/**
+ * A gradient fill for a shape (replaces `fillColor`). Positions are relative to the shape's own
+ * bounds (0–1), so it follows the shape's size. Colours may have alpha (`'rgba(0,0,0,0.6)'`), so a
+ * radial gradient from transparent to dark is a vignette. Not animatable.
+ */
+interface GradientSpec {
+    /** Default `'linear'`. */
+    type?: 'linear' | 'radial';
+    /** Colour stops, `[offset 0–1, colour]` or `{ offset, color }`. At least two. */
+    stops: Array<[number, string | number] | {
+        offset: number;
+        color: string | number;
+    }>;
+    /** linear: direction in degrees — 0 = left → right, 90 = top → bottom (default). */
+    angle?: number;
+    /** radial: centre in 0–1 of the bounds. Default `[0.5, 0.5]`. */
+    center?: [number, number];
+    /** radial: inner radius where the first stop applies, 0–1. Default 0. */
+    innerRadius?: number;
+    /** radial: outer radius where the last stop applies, 0–1. Default 0.5. */
+    radius?: number;
+}
 interface ShapeBase extends SequenceCommon {
     type: 'shape';
+    /** Fill with a gradient instead of `fillColor` (top level or in `initial`). */
+    fillGradient?: GradientSpec;
     /**
      * Colour space used to interpolate `fillColor` / `strokeColor` keyframes.
      *
@@ -277,7 +337,7 @@ interface PathShapeSpec extends ShapeBase {
     d: string;
 }
 type ShapeSequenceSpec = RectShapeSpec | CircleShapeSpec | EllipseShapeSpec | LineShapeSpec | PolygonShapeSpec | PathShapeSpec;
-type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | ShapeSequenceSpec;
+type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | CameraSequenceSpec | ShapeSequenceSpec;
 /** Top-level composition (root node) — same as `CompositionSequenceSpec` minus the discriminant. */
 interface CompositionSpec extends SequenceCommon {
     width?: number;
@@ -285,80 +345,23 @@ interface CompositionSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
-
-interface MovieOptions {
-    width?: number;
-    height?: number;
-    duration?: number;
-    frameRate?: number;
-    background?: string;
-    canvas?: HTMLCanvasElement;
-    assets?: AssetSpec[];
-    composition?: CompositionSpec;
-}
-interface RenderOptions {
-    format?: 'mp4' | 'mov' | 'webm' | 'mkv';
-    video?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-    audio?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-}
-interface FrameEvent {
-    frame: number;
-    totalFrames: number;
-}
-interface ProgressEvent {
-    progress: number;
-    frame: number;
-    totalFrames: number;
-}
-type Listener = (...args: any[]) => void;
-declare class Movie {
-    private _events;
-    private _initState;
-    app: Application | null;
-    timeline: ReturnType<typeof gsap.timeline> | null;
-    audioBuffer: AudioBuffer | null;
-    audioSource: AudioBufferSourceNode | null;
-    gainNode: GainNode | null;
-    private _volume;
-    private _muted;
-    isPlaying: boolean;
-    currentFrame: number;
-    totalFrames: number;
+/** Resolved parent / root composition shape used for scope and sizing. */
+interface CompositionShape {
     width: number;
     height: number;
     duration: number;
-    frameRate: number;
-    background: string;
-    private _audioContext;
-    private _rootSequence;
-    private _rootContainer;
-    private _raf;
-    on(event: 'ready', fn: () => void): this;
-    on(event: 'frame', fn: (e: FrameEvent) => void): this;
-    on(event: 'progress', fn: (e: ProgressEvent) => void): this;
-    on(event: 'pause', fn: () => void): this;
-    off(event: string, fn: Listener): this;
-    emit(event: string, ...args: unknown[]): void;
-    get isReady(): boolean;
-    private _ensureAudioContext;
-    init(options?: MovieOptions): Promise<void>;
-    gotoFrame(frame: number, force?: boolean): Promise<void>;
-    private _awaitVideoFrames;
-    play(): void;
-    pause(): void;
-    set volume(v: number);
-    get volume(): number;
-    set muted(v: boolean);
-    get muted(): boolean;
-    toggleMute(): boolean;
-    render(options?: RenderOptions): Promise<Blob>;
-    destroy(): Promise<void>;
+}
+/** Audio descriptor pushed to the mixdown queue by AudioSequence/VideoSequence. */
+interface AudioDescriptor {
+    buffer: AudioBuffer;
+    loop: boolean;
+    start: number;
+    end: number;
+    initialVolume: number;
+    volumeKeyframes: {
+        time: number;
+        value: number;
+    }[];
 }
 
-export { type AssetSpec as A, type ChromaKeyFilterSpec as C, type DipTransition as D, type EllipseShapeSpec as E, type FilterSpec as F, type ImageSequenceSpec as I, type Keyframe as K, type LineShapeSpec as L, Movie as M, type PathShapeSpec as P, type RectShapeSpec as R, type SequenceCommon as S, type TextSequenceSpec as T, type VideoSequenceSpec as V, type WipeTransition as W, type ZoomTransition as Z, type AudioSequenceSpec as a, type CircleShapeSpec as b, type CompositionSequenceSpec as c, type CompositionSpec as d, type CrossfadeTransition as e, type CustomFilterSpec as f, type DissolveTransition as g, type Expr as h, type FrameEvent as i, type IrisTransition as j, type MovieOptions as k, type PolygonShapeSpec as l, type ProgressEvent as m, type PropValue as n, type Props as o, type RenderOptions as p, type SequenceSpec as q, type ShapeSequenceSpec as r, type SlideTransition as s, type TransitionCommon as t, type TransitionSpec as u };
+export type { AssetSpec as A, CompositionShape as C, DipTransition as D, EllipseShapeSpec as E, FilterSpec as F, GradientSpec as G, ImageSequenceSpec as I, Keyframe as K, LineShapeSpec as L, PathShapeSpec as P, RectShapeSpec as R, SequenceSpec as S, TextSequenceSpec as T, VideoSequenceSpec as V, WipeTransition as W, ZoomTransition as Z, CameraSequenceSpec as a, SequenceCommon as b, AudioSequenceSpec as c, ChromaKeyFilterSpec as d, CircleShapeSpec as e, CompositionSequenceSpec as f, CompositionSpec as g, CrossfadeTransition as h, CustomFilterSpec as i, DissolveTransition as j, Expr as k, IrisTransition as l, PolygonShapeSpec as m, PropValue as n, Props as o, ShapeSequenceSpec as p, SlideTransition as q, TransitionCommon as r, TransitionSpec as s, AudioDescriptor as t };

package/dist/{Movie-Bp66rkaC.d.ts → types-3c8Vymgw.d.ts}

@@ -1,6 +1,3 @@
-import { Application } from 'pixi.js';
-import { gsap } from 'gsap';
-
 /**
  * pixi-effects public DSL types.
  *
@@ -16,9 +13,21 @@ type PropValue = number | string;
 type Props = Record<string, PropValue>;
 /** A single keyframe entry. Either `set`, `to`, `from`, or `from`+`to` is meaningful per kind. */
 interface Keyframe {
+    /**
+     * Start time in seconds, measured from the start of the sequence this
+     * keyframe belongs to (After Effects style): `0` = the moment the layer
+     * appears. Negative values count back from the sequence's end
+     * (`-0.5` = 0.5 s before it ends).
+     */
     at?: number;
     duration?: number;
     ease?: string;
+    /** Extra plays of this tween after the first (a finite count; infinite repeats are not allowed — the timeline needs a fixed length). Total time = duration × (repeat + 1) plus delays. */
+    repeat?: number;
+    /** With `repeat`: every other play runs backwards (there-and-back). */
+    yoyo?: boolean;
+    /** With `repeat`: seconds to wait between plays. */
+    repeatDelay?: number;
     set?: Props;
     to?: Props;
     from?: Props;
@@ -66,7 +75,7 @@ interface TransitionCommon {
     from: string;
     /** Sibling sequence's `name` — the incoming scene. Must be declared after `from` in the parent's `sequences[]`. */
     to: string;
-    /** Start time (parent-relative seconds). Same `at` semantics as Keyframe. */
+    /** Start time in the PARENT composition's time (like a sequence's `at`, not sequence-local). Negative = back from the parent's end. */
     at: number;
     /** Length of the transition in seconds. Must be > 0. */
     duration: number;
@@ -130,10 +139,11 @@ interface SequenceCommon {
     filters?: FilterSpec[];
     /**
      * Override PIXI's auto-computed filter region. By default, filters apply
-     * only inside the target's bounding box. Setting this to a parent-relative
-     * rectangle lets a filter (e.g. a wipe / iris transition) draw across an
-     * area larger than the sprite — useful when the sprite content is small
-     * but the visual effect should cover the whole composition.
+     * only inside the target's bounding box. This rectangle is in the layer's
+     * OWN coordinate space (origin = the layer's local origin, before its
+     * x/y/scale/rotation — e.g. a circle's centre), not the parent's. Use it to
+     * let a filter (blur, glow, a wipe / iris transition) draw beyond the
+     * layer's own bounds; without it a blur is clipped to the bounding box.
      */
     filterArea?: {
         x: number;
@@ -164,6 +174,13 @@ interface SequenceCommon {
      * Routed through PIXI's native `setMask({ inverse: true })`.
      */
     maskInverted?: boolean;
+    /**
+     * Opt this layer into 2.5D: it can then use `z`, `rotationX`, `rotationY`
+     * (in `initial` / keyframes) and is projected through the composition's
+     * `camera` layer. Default false. With z = 0, no 3D rotation and the default
+     * camera, a threeD layer renders exactly like a 2D one.
+     */
+    threeD?: boolean;
 }
 interface VideoSequenceSpec extends SequenceCommon {
     type: 'video';
@@ -185,7 +202,17 @@ interface ImageSequenceSpec extends SequenceCommon {
 }
 interface TextSequenceSpec extends SequenceCommon {
     type: 'text';
+    /**
+     * The text. May contain `{value}`, replaced by the layer's animatable number
+     * `value` (a counter): `text: '{value} users'`, `initial: { value: 0 }`,
+     * keyframe `to: { value: 2480 }`. Format it with `format`.
+     */
     text?: string;
+    /** How `{value}` is printed: `decimals` (default 0) and thousands `grouping` (default false). */
+    format?: {
+        decimals?: number;
+        grouping?: boolean;
+    };
     /** Subset of PIXI v8 TextStyleOptions. String values may be exprs (e.g. fontSize: 'GW * 0.05'). */
     style?: Record<string, PropValue | {
         color?: PropValue;
@@ -212,8 +239,41 @@ interface CompositionSequenceSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
+/**
+ * A camera layer. Put its props in `initial` / `keyframes`:
+ * `x`, `y`, `z`, `lookAtX`, `lookAtY`, `lookAtZ`, `fov` (vertical degrees, default 40).
+ * Unset `z` follows `fov` so the z = 0 plane stays 1:1. Affects only `threeD`
+ * siblings in the same composition. +z points toward the viewer.
+ */
+interface CameraSequenceSpec extends SequenceCommon {
+    type: 'camera';
+}
+/**
+ * A gradient fill for a shape (replaces `fillColor`). Positions are relative to the shape's own
+ * bounds (0–1), so it follows the shape's size. Colours may have alpha (`'rgba(0,0,0,0.6)'`), so a
+ * radial gradient from transparent to dark is a vignette. Not animatable.
+ */
+interface GradientSpec {
+    /** Default `'linear'`. */
+    type?: 'linear' | 'radial';
+    /** Colour stops, `[offset 0–1, colour]` or `{ offset, color }`. At least two. */
+    stops: Array<[number, string | number] | {
+        offset: number;
+        color: string | number;
+    }>;
+    /** linear: direction in degrees — 0 = left → right, 90 = top → bottom (default). */
+    angle?: number;
+    /** radial: centre in 0–1 of the bounds. Default `[0.5, 0.5]`. */
+    center?: [number, number];
+    /** radial: inner radius where the first stop applies, 0–1. Default 0. */
+    innerRadius?: number;
+    /** radial: outer radius where the last stop applies, 0–1. Default 0.5. */
+    radius?: number;
+}
 interface ShapeBase extends SequenceCommon {
     type: 'shape';
+    /** Fill with a gradient instead of `fillColor` (top level or in `initial`). */
+    fillGradient?: GradientSpec;
     /**
      * Colour space used to interpolate `fillColor` / `strokeColor` keyframes.
      *
@@ -277,7 +337,7 @@ interface PathShapeSpec extends ShapeBase {
     d: string;
 }
 type ShapeSequenceSpec = RectShapeSpec | CircleShapeSpec | EllipseShapeSpec | LineShapeSpec | PolygonShapeSpec | PathShapeSpec;
-type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | ShapeSequenceSpec;
+type SequenceSpec = VideoSequenceSpec | ImageSequenceSpec | TextSequenceSpec | AudioSequenceSpec | CompositionSequenceSpec | CameraSequenceSpec | ShapeSequenceSpec;
 /** Top-level composition (root node) — same as `CompositionSequenceSpec` minus the discriminant. */
 interface CompositionSpec extends SequenceCommon {
     width?: number;
@@ -285,80 +345,23 @@ interface CompositionSpec extends SequenceCommon {
     sequences?: SequenceSpec[];
     transitions?: TransitionSpec[];
 }
-
-interface MovieOptions {
-    width?: number;
-    height?: number;
-    duration?: number;
-    frameRate?: number;
-    background?: string;
-    canvas?: HTMLCanvasElement;
-    assets?: AssetSpec[];
-    composition?: CompositionSpec;
-}
-interface RenderOptions {
-    format?: 'mp4' | 'mov' | 'webm' | 'mkv';
-    video?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-    audio?: {
-        codec?: string;
-        bitrate?: 'very-low' | 'low' | 'medium' | 'high' | 'very-high';
-    };
-}
-interface FrameEvent {
-    frame: number;
-    totalFrames: number;
-}
-interface ProgressEvent {
-    progress: number;
-    frame: number;
-    totalFrames: number;
-}
-type Listener = (...args: any[]) => void;
-declare class Movie {
-    private _events;
-    private _initState;
-    app: Application | null;
-    timeline: ReturnType<typeof gsap.timeline> | null;
-    audioBuffer: AudioBuffer | null;
-    audioSource: AudioBufferSourceNode | null;
-    gainNode: GainNode | null;
-    private _volume;
-    private _muted;
-    isPlaying: boolean;
-    currentFrame: number;
-    totalFrames: number;
+/** Resolved parent / root composition shape used for scope and sizing. */
+interface CompositionShape {
     width: number;
     height: number;
     duration: number;
-    frameRate: number;
-    background: string;
-    private _audioContext;
-    private _rootSequence;
-    private _rootContainer;
-    private _raf;
-    on(event: 'ready', fn: () => void): this;
-    on(event: 'frame', fn: (e: FrameEvent) => void): this;
-    on(event: 'progress', fn: (e: ProgressEvent) => void): this;
-    on(event: 'pause', fn: () => void): this;
-    off(event: string, fn: Listener): this;
-    emit(event: string, ...args: unknown[]): void;
-    get isReady(): boolean;
-    private _ensureAudioContext;
-    init(options?: MovieOptions): Promise<void>;
-    gotoFrame(frame: number, force?: boolean): Promise<void>;
-    private _awaitVideoFrames;
-    play(): void;
-    pause(): void;
-    set volume(v: number);
-    get volume(): number;
-    set muted(v: boolean);
-    get muted(): boolean;
-    toggleMute(): boolean;
-    render(options?: RenderOptions): Promise<Blob>;
-    destroy(): Promise<void>;
+}
+/** Audio descriptor pushed to the mixdown queue by AudioSequence/VideoSequence. */
+interface AudioDescriptor {
+    buffer: AudioBuffer;
+    loop: boolean;
+    start: number;
+    end: number;
+    initialVolume: number;
+    volumeKeyframes: {
+        time: number;
+        value: number;
+    }[];
 }
 
-export { type AssetSpec as A, type ChromaKeyFilterSpec as C, type DipTransition as D, type EllipseShapeSpec as E, type FilterSpec as F, type ImageSequenceSpec as I, type Keyframe as K, type LineShapeSpec as L, Movie as M, type PathShapeSpec as P, type RectShapeSpec as R, type SequenceCommon as S, type TextSequenceSpec as T, type VideoSequenceSpec as V, type WipeTransition as W, type ZoomTransition as Z, type AudioSequenceSpec as a, type CircleShapeSpec as b, type CompositionSequenceSpec as c, type CompositionSpec as d, type CrossfadeTransition as e, type CustomFilterSpec as f, type DissolveTransition as g, type Expr as h, type FrameEvent as i, type IrisTransition as j, type MovieOptions as k, type PolygonShapeSpec as l, type ProgressEvent as m, type PropValue as n, type Props as o, type RenderOptions as p, type SequenceSpec as q, type ShapeSequenceSpec as r, type SlideTransition as s, type TransitionCommon as t, type TransitionSpec as u };
+export type { AssetSpec as A, CompositionShape as C, DipTransition as D, EllipseShapeSpec as E, FilterSpec as F, GradientSpec as G, ImageSequenceSpec as I, Keyframe as K, LineShapeSpec as L, PathShapeSpec as P, RectShapeSpec as R, SequenceSpec as S, TextSequenceSpec as T, VideoSequenceSpec as V, WipeTransition as W, ZoomTransition as Z, CameraSequenceSpec as a, SequenceCommon as b, AudioSequenceSpec as c, ChromaKeyFilterSpec as d, CircleShapeSpec as e, CompositionSequenceSpec as f, CompositionSpec as g, CrossfadeTransition as h, CustomFilterSpec as i, DissolveTransition as j, Expr as k, IrisTransition as l, PolygonShapeSpec as m, PropValue as n, Props as o, ShapeSequenceSpec as p, SlideTransition as q, TransitionCommon as r, TransitionSpec as s, AudioDescriptor as t };