pixi-effects 0.1.0 → 0.2.0

package/dist/index.d.cts

@@ -1,8 +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 { F as FrameEvent, M as Movie, a as MovieOptions, P as ProgressEvent, R as RenderOptions } from './Movie-CcR6h2jO.cjs';
+import { S as Sequence } from './Base-B1Tdn0Cv.cjs';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as SequenceCommon } from './types-CNBilhpz.cjs';
+export { A as AssetSpec, b as AudioSequenceSpec, c as CameraSequenceSpec, 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, 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-CNBilhpz.cjs';
 import 'pixi.js';
 import 'gsap';
 
+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;
+
 /**
  * Ken Burns preset for a single image. Returns an `ImageSequenceSpec` ready
  * to drop into a composition's `sequences[]`.
@@ -76,4 +84,37 @@ interface KenBurnsPosition {
 }
 declare function kenBurns(opts: KenBurnsOptions): ImageSequenceSpec;
 
-export { ImageSequenceSpec, type KenBurnsOptions, kenBurns };
+interface WithFadeOptions {
+    /** Fade-in duration (seconds), anchored to the sequence's `at`. */
+    in?: number;
+    /** Fade-out duration (seconds), anchored to `at + duration`. 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.
+ *
+ * The keyframe `at` values use the sequence's own `at` and `at + duration`,
+ * which the runtime interprets parent-relative. 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 { ImageSequenceSpec, type KenBurnsOptions, SequenceCommon, type SequenceCtor, SequenceSpec, type WithFadeOptions, kenBurns, registerSequenceType, withFade };

package/dist/index.d.ts

@@ -1,8 +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 { F as FrameEvent, M as Movie, a as MovieOptions, P as ProgressEvent, R as RenderOptions } from './Movie-D-n8glA6.js';
+import { S as Sequence } from './Base-Bh_VSusi.js';
+import { S as SequenceSpec, C as CompositionShape, I as ImageSequenceSpec, a as SequenceCommon } from './types-CNBilhpz.js';
+export { A as AssetSpec, b as AudioSequenceSpec, c as CameraSequenceSpec, 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, 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-CNBilhpz.js';
 import 'pixi.js';
 import 'gsap';
 
+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;
+
 /**
  * Ken Burns preset for a single image. Returns an `ImageSequenceSpec` ready
  * to drop into a composition's `sequences[]`.
@@ -76,4 +84,37 @@ interface KenBurnsPosition {
 }
 declare function kenBurns(opts: KenBurnsOptions): ImageSequenceSpec;
 
-export { ImageSequenceSpec, type KenBurnsOptions, kenBurns };
+interface WithFadeOptions {
+    /** Fade-in duration (seconds), anchored to the sequence's `at`. */
+    in?: number;
+    /** Fade-out duration (seconds), anchored to `at + duration`. 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.
+ *
+ * The keyframe `at` values use the sequence's own `at` and `at + duration`,
+ * which the runtime interprets parent-relative. 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 { ImageSequenceSpec, type KenBurnsOptions, SequenceCommon, type SequenceCtor, SequenceSpec, type WithFadeOptions, kenBurns, registerSequenceType, withFade };