pixi-effects 0.1.0 → 0.3.0

package/dist/index.d.cts

@@ -1,29 +1,16 @@
-import { I as ImageSequenceSpec } from './Movie-Bp66rkaC.cjs';
-export { A as AssetSpec, a as AudioSequenceSpec, C as ChromaKeyFilterSpec, b as CircleShapeSpec, c as CompositionSequenceSpec, d as CompositionSpec, e as CrossfadeTransition, f as CustomFilterSpec, D as DipTransition, g as DissolveTransition, E as EllipseShapeSpec, h as Expr, F as FilterSpec, i as FrameEvent, j as IrisTransition, K as Keyframe, L as LineShapeSpec, M as Movie, k as MovieOptions, P as PathShapeSpec, l as PolygonShapeSpec, m as ProgressEvent, n as PropValue, o as Props, R as RectShapeSpec, p as RenderOptions, S as SequenceCommon, q as SequenceSpec, r as ShapeSequenceSpec, s as SlideTransition, T as TextSequenceSpec, t as TransitionCommon, u as TransitionSpec, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition } from './Movie-Bp66rkaC.cjs';
+export { C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, a as InspectReport, L as LayerInfo, M as Movie, b as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions } from './Movie-W8ISiEBB.cjs';
+import { S as Sequence } from './Base-BDw6dKRB.cjs';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, b as SequenceCommon } from './types-3c8Vymgw.cjs';
+export { A as AssetSpec, c as AudioSequenceSpec, d as ChromaKeyFilterSpec, e as CircleShapeSpec, f as CompositionSequenceSpec, g as CompositionSpec, h as CrossfadeTransition, i as CustomFilterSpec, D as DipTransition, j as DissolveTransition, E as EllipseShapeSpec, k as Expr, F as FilterSpec, G as GradientSpec, l as IrisTransition, K as Keyframe, L as LineShapeSpec, P as PathShapeSpec, m as PolygonShapeSpec, n as PropValue, o as Props, R as RectShapeSpec, p as ShapeSequenceSpec, q as SlideTransition, T as TextSequenceSpec, r as TransitionCommon, s as TransitionSpec, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition } from './types-3c8Vymgw.cjs';
 import 'pixi.js';
 import 'gsap';
 
-/**
- * Ken Burns preset for a single image. Returns an `ImageSequenceSpec` ready
- * to drop into a composition's `sequences[]`.
- *
- * Four motion modes:
- *   - `still`    : just sit at the canvas centre, fitted but unanimated.
- *   - `scale`    : zoom in or out around an arbitrary 9-point pivot.
- *   - `rotation` : gentle rotation while keeping the image filling the
- *                  canvas (the scale is over-set so even at the steepest
- *                  rotation the bounding box still covers).
- *   - `position` : pan the image between two points within its over-scaled
- *                  bounds (corner-to-corner by default).
- *
- * The image fits the canvas by `cover` (default) or `contain` — both
- * computed at runtime from the texture's intrinsic size, so you don't pass
- * `imageWidth` / `imageHeight`. Position keyframes assume the image is
- * anchored at its centre (anchor 0.5/0.5).
- *
- * Note: this preset emits no fade keyframes; pair it with `crossfade` /
- * `dip` / etc. transitions to chain images.
- */
+type SequenceCtor = {
+    new (spec: SequenceSpec, parent: CompositionShape | null, root: CompositionShape): Sequence;
+};
+/** Register an external sequence type. Later registrations overwrite earlier ones. */
+declare function registerSequenceType(type: string, ctor: SequenceCtor): void;
+
 type KenBurnsOptions = KenBurnsBase & ({
     motion: 'still';
 } | KenBurnsScale | KenBurnsRotation | KenBurnsPosition);
@@ -76,4 +63,88 @@ interface KenBurnsPosition {
 }
 declare function kenBurns(opts: KenBurnsOptions): ImageSequenceSpec;
 
-export { ImageSequenceSpec, type KenBurnsOptions, kenBurns };
+interface OrbitOptions {
+    /** Length of the move in seconds. Required, > 0. */
+    duration: number;
+    /** Total sweep in degrees (negative = the other way). The camera passes straight-ahead (angle 0) in the middle when `start` is left at its default. */
+    degrees: number;
+    /** Angle the move starts at, in degrees (0 = straight in front of the centre). Default `-degrees / 2`. */
+    start?: number;
+    /** Distance from the centre. Default: the default camera distance for `height` and `fov` (so `z = 0` is 1:1 at angle 0). */
+    radius?: number;
+    /** The point to circle around and look at, in composition pixels. Default: the centre of `width` × `height`. */
+    center?: [number, number];
+    /** Composition size, used for the default `center` and `radius`. Default 1280 × 720. */
+    width?: number;
+    height?: number;
+    /** Vertical field of view, degrees. Default 40. Written to the camera. */
+    fov?: number;
+    /** Easing of the sweep as a whole (any GSAP ease). Default `'sine.inOut'`. */
+    ease?: string;
+    /**
+     * A dolly zoom while orbiting: `fov` animates from `from` to `to` (degrees) and the radius follows it
+     * (`R = (height/2) / tan(fov/2)`), so the `z = 0` plane keeps its size while the perspective changes.
+     * Cannot be combined with `radius`. `ease` defaults to the sweep's ease.
+     */
+    dollyZoom?: {
+        from: number;
+        to: number;
+        ease?: string;
+    };
+    /** Start time in seconds (composition time, like any layer). */
+    at?: number;
+    name?: string;
+    /** Sampling density. Default one segment per 0.1 s. */
+    stepsPerSecond?: number;
+}
+/**
+ * A camera that orbits a point. There is no per-frame expression in the DSL, so the circle is sampled
+ * into short linear keyframes (the easing is applied to the angle). Drop the result into `sequences[]`
+ * next to `threeD` layers.
+ *
+ * ```ts
+ * orbit({ duration: 6, degrees: 40 })                       // sweep ±20° around the centre
+ * orbit({ duration: 4, degrees: 90, start: 0, radius: 900 })
+ * ```
+ *
+ * `z` is specified, so it no longer follows `fov`. For a dolly zoom WHILE orbiting pass
+ * `dollyZoom: { from: 38, to: 64 }`: `fov` animates and the radius follows it (`z = (H/2) / tan(fov/2)`),
+ * keeping the `z = 0` plane the same size.
+ */
+declare function orbit(opts: OrbitOptions): CameraSequenceSpec;
+
+interface WithFadeOptions {
+    /** Fade-in duration (seconds), at the start of the sequence. */
+    in?: number;
+    /** Fade-out duration (seconds), ending at the end of the sequence. Requires `duration` to be set on the spec. */
+    out?: number;
+}
+/**
+ * Add alpha fade-in / fade-out keyframes to a sequence spec. Mutates and
+ * returns the spec so the result can be dropped straight into `sequences[]`.
+ *
+ * ```ts
+ * sequences: [
+ *   withFade(
+ *     kenBurns({ asset: 'p', at: 0, duration: 6, motion: 'scale' }),
+ *     { in: 0.5, out: 0.5 },
+ *   ),
+ *
+ *   withFade(
+ *     { type: 'text', text: 'hi', at: 5, duration: 3, initial: { x: 'GW/2' } },
+ *     { in: 0.4 },
+ *   ),
+ * ]
+ * ```
+ *
+ * The added keyframes are layered on top of any keyframes the spec already
+ * has — kenBurns's scale / position / rotation tweens keep working.
+ *
+ * Keyframe `at` is sequence-local: the fade-in starts at 0 and the fade-out
+ * at `duration - out`, whatever the sequence's own `at` is. Works the same
+ * whether the spec sits directly under the root composition or nested inside
+ * another.
+ */
+declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
+
+export { CameraSequenceSpec, ImageSequenceSpec, type KenBurnsOptions, type OrbitOptions, SequenceCommon, type SequenceCtor, SequenceSpec, type WithFadeOptions, kenBurns, orbit, registerSequenceType, withFade };

package/dist/index.d.ts

@@ -1,29 +1,16 @@
-import { I as ImageSequenceSpec } from './Movie-Bp66rkaC.js';
-export { A as AssetSpec, a as AudioSequenceSpec, C as ChromaKeyFilterSpec, b as CircleShapeSpec, c as CompositionSequenceSpec, d as CompositionSpec, e as CrossfadeTransition, f as CustomFilterSpec, D as DipTransition, g as DissolveTransition, E as EllipseShapeSpec, h as Expr, F as FilterSpec, i as FrameEvent, j as IrisTransition, K as Keyframe, L as LineShapeSpec, M as Movie, k as MovieOptions, P as PathShapeSpec, l as PolygonShapeSpec, m as ProgressEvent, n as PropValue, o as Props, R as RectShapeSpec, p as RenderOptions, S as SequenceCommon, q as SequenceSpec, r as ShapeSequenceSpec, s as SlideTransition, T as TextSequenceSpec, t as TransitionCommon, u as TransitionSpec, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition } from './Movie-Bp66rkaC.js';
+export { C as ContactSheetOptions, F as FrameEvent, I as InspectOptions, a as InspectReport, L as LayerInfo, M as Movie, b as MovieOptions, P as ProgressEvent, R as RenderOptions, S as SnapshotOptions } from './Movie-DMpaT67V.js';
+import { S as Sequence } from './Base-Ba4Ta4ap.js';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as CameraSequenceSpec, b as SequenceCommon } from './types-3c8Vymgw.js';
+export { A as AssetSpec, c as AudioSequenceSpec, d as ChromaKeyFilterSpec, e as CircleShapeSpec, f as CompositionSequenceSpec, g as CompositionSpec, h as CrossfadeTransition, i as CustomFilterSpec, D as DipTransition, j as DissolveTransition, E as EllipseShapeSpec, k as Expr, F as FilterSpec, G as GradientSpec, l as IrisTransition, K as Keyframe, L as LineShapeSpec, P as PathShapeSpec, m as PolygonShapeSpec, n as PropValue, o as Props, R as RectShapeSpec, p as ShapeSequenceSpec, q as SlideTransition, T as TextSequenceSpec, r as TransitionCommon, s as TransitionSpec, V as VideoSequenceSpec, W as WipeTransition, Z as ZoomTransition } from './types-3c8Vymgw.js';
 import 'pixi.js';
 import 'gsap';
 
-/**
- * Ken Burns preset for a single image. Returns an `ImageSequenceSpec` ready
- * to drop into a composition's `sequences[]`.
- *
- * Four motion modes:
- *   - `still`    : just sit at the canvas centre, fitted but unanimated.
- *   - `scale`    : zoom in or out around an arbitrary 9-point pivot.
- *   - `rotation` : gentle rotation while keeping the image filling the
- *                  canvas (the scale is over-set so even at the steepest
- *                  rotation the bounding box still covers).
- *   - `position` : pan the image between two points within its over-scaled
- *                  bounds (corner-to-corner by default).
- *
- * The image fits the canvas by `cover` (default) or `contain` — both
- * computed at runtime from the texture's intrinsic size, so you don't pass
- * `imageWidth` / `imageHeight`. Position keyframes assume the image is
- * anchored at its centre (anchor 0.5/0.5).
- *
- * Note: this preset emits no fade keyframes; pair it with `crossfade` /
- * `dip` / etc. transitions to chain images.
- */
+type SequenceCtor = {
+    new (spec: SequenceSpec, parent: CompositionShape | null, root: CompositionShape): Sequence;
+};
+/** Register an external sequence type. Later registrations overwrite earlier ones. */
+declare function registerSequenceType(type: string, ctor: SequenceCtor): void;
+
 type KenBurnsOptions = KenBurnsBase & ({
     motion: 'still';
 } | KenBurnsScale | KenBurnsRotation | KenBurnsPosition);
@@ -76,4 +63,88 @@ interface KenBurnsPosition {
 }
 declare function kenBurns(opts: KenBurnsOptions): ImageSequenceSpec;
 
-export { ImageSequenceSpec, type KenBurnsOptions, kenBurns };
+interface OrbitOptions {
+    /** Length of the move in seconds. Required, > 0. */
+    duration: number;
+    /** Total sweep in degrees (negative = the other way). The camera passes straight-ahead (angle 0) in the middle when `start` is left at its default. */
+    degrees: number;
+    /** Angle the move starts at, in degrees (0 = straight in front of the centre). Default `-degrees / 2`. */
+    start?: number;
+    /** Distance from the centre. Default: the default camera distance for `height` and `fov` (so `z = 0` is 1:1 at angle 0). */
+    radius?: number;
+    /** The point to circle around and look at, in composition pixels. Default: the centre of `width` × `height`. */
+    center?: [number, number];
+    /** Composition size, used for the default `center` and `radius`. Default 1280 × 720. */
+    width?: number;
+    height?: number;
+    /** Vertical field of view, degrees. Default 40. Written to the camera. */
+    fov?: number;
+    /** Easing of the sweep as a whole (any GSAP ease). Default `'sine.inOut'`. */
+    ease?: string;
+    /**
+     * A dolly zoom while orbiting: `fov` animates from `from` to `to` (degrees) and the radius follows it
+     * (`R = (height/2) / tan(fov/2)`), so the `z = 0` plane keeps its size while the perspective changes.
+     * Cannot be combined with `radius`. `ease` defaults to the sweep's ease.
+     */
+    dollyZoom?: {
+        from: number;
+        to: number;
+        ease?: string;
+    };
+    /** Start time in seconds (composition time, like any layer). */
+    at?: number;
+    name?: string;
+    /** Sampling density. Default one segment per 0.1 s. */
+    stepsPerSecond?: number;
+}
+/**
+ * A camera that orbits a point. There is no per-frame expression in the DSL, so the circle is sampled
+ * into short linear keyframes (the easing is applied to the angle). Drop the result into `sequences[]`
+ * next to `threeD` layers.
+ *
+ * ```ts
+ * orbit({ duration: 6, degrees: 40 })                       // sweep ±20° around the centre
+ * orbit({ duration: 4, degrees: 90, start: 0, radius: 900 })
+ * ```
+ *
+ * `z` is specified, so it no longer follows `fov`. For a dolly zoom WHILE orbiting pass
+ * `dollyZoom: { from: 38, to: 64 }`: `fov` animates and the radius follows it (`z = (H/2) / tan(fov/2)`),
+ * keeping the `z = 0` plane the same size.
+ */
+declare function orbit(opts: OrbitOptions): CameraSequenceSpec;
+
+interface WithFadeOptions {
+    /** Fade-in duration (seconds), at the start of the sequence. */
+    in?: number;
+    /** Fade-out duration (seconds), ending at the end of the sequence. Requires `duration` to be set on the spec. */
+    out?: number;
+}
+/**
+ * Add alpha fade-in / fade-out keyframes to a sequence spec. Mutates and
+ * returns the spec so the result can be dropped straight into `sequences[]`.
+ *
+ * ```ts
+ * sequences: [
+ *   withFade(
+ *     kenBurns({ asset: 'p', at: 0, duration: 6, motion: 'scale' }),
+ *     { in: 0.5, out: 0.5 },
+ *   ),
+ *
+ *   withFade(
+ *     { type: 'text', text: 'hi', at: 5, duration: 3, initial: { x: 'GW/2' } },
+ *     { in: 0.4 },
+ *   ),
+ * ]
+ * ```
+ *
+ * The added keyframes are layered on top of any keyframes the spec already
+ * has — kenBurns's scale / position / rotation tweens keep working.
+ *
+ * Keyframe `at` is sequence-local: the fade-in starts at 0 and the fade-out
+ * at `duration - out`, whatever the sequence's own `at` is. Works the same
+ * whether the spec sits directly under the root composition or nested inside
+ * another.
+ */
+declare function withFade<T extends SequenceCommon>(spec: T, opts: WithFadeOptions): T;
+
+export { CameraSequenceSpec, ImageSequenceSpec, type KenBurnsOptions, type OrbitOptions, SequenceCommon, type SequenceCtor, SequenceSpec, type WithFadeOptions, kenBurns, orbit, registerSequenceType, withFade };