pixi-effects 0.28.2 → 0.29.0

package/dist/{types-DpK1vwcl.d.ts → types-BzIB65Vk.d.cts}

@@ -1,128 +1,3 @@
-type EaseFn = (p: number) => number;
-
-/**
- * A timeline that is a pure function of time (spike: see docs/superpowers/specs/2026-10-10-pure-timeline-design.md).
- *
- * For every (target, property) it keeps the segments that write it, ordered by start time. The value at `t`
- * is the value of the last segment that has started, computed from `t` alone; nothing is remembered between
- * two calls except the start values captured when the segment was built. GSAP is the oracle: the rules below
- * were taken from black-box probes of `gsap.timeline` and are checked against it by tests/core/pure/timelineParity.test.ts.
- */
-interface PureVars {
-    duration?: number;
-    ease?: string | EaseFn;
-    repeat?: number;
-    yoyo?: boolean;
-    repeatDelay?: number;
-    onUpdate?: () => void;
-    /** The Pixi plugin's shorthands: `scale`, `anchor`, `rotation` (degrees), `tint`, `autoAlpha` ... */
-    pixi?: Record<string, unknown>;
-    [prop: string]: unknown;
-}
-/** One thing a timeline writes: see `segments()`. */
-interface SegmentInfo {
-    target: object;
-    /** The property (`'alpha'`, `'scale.x'`, `'fill'`). */
-    id: string;
-    start: number;
-    duration: number;
-    repeat: number;
-    yoyo: boolean;
-    repeatDelay: number;
-    kind: 'set' | 'to' | 'from' | 'fromTo';
-}
-/** A marker that only lengthens a timeline (what `gsap.to({}, { duration })` is used for). */
-interface Spacer {
-    readonly spacer: true;
-    readonly duration: number;
-}
-declare class PureTimeline {
-    private readonly defaultEase;
-    private readonly channels;
-    private readonly channelList;
-    private readonly children;
-    private spans;
-    private now;
-    private order;
-    private killed;
-    private prepared;
-    constructor(opts?: {
-        paused?: boolean;
-        defaults?: {
-            ease?: string | EaseFn;
-        };
-    });
-    /** Adds a child timeline (played with its local time) or a spacer that lengthens this one. */
-    add(child: PureTimeline | Spacer, at?: number): this;
-    set(target: object, vars: PureVars, at?: number): this;
-    to(target: object, vars: PureVars, at?: number): this;
-    from(target: object, vars: PureVars, at?: number): this;
-    fromTo(target: object, fromVars: PureVars, toVars: PureVars, at?: number): this;
-    private build;
-    private channel;
-    /**
-     * A property moved by a function of the caller (a colour in OKLab, a gradient): `to` and `from` say how to get the two ends from
-     * the value before the segment, `make` the interpolator between them. The value is only written while the segment is the last
-     * one that has started, so nothing is read or kept between two frames.
-     */
-    tweenValue<T>(spec: {
-        holder: object;
-        id: string;
-        get(): T;
-        set(v: T): void;
-        from?: (prev: T) => T;
-        to: (start: T, prev: T, base: T) => T;
-        make: (a: T, b: T) => (p: number) => T;
-        duration: number;
-        ease: string | EaseFn;
-        at: number;
-        repeat?: number;
-        yoyo?: boolean;
-        repeatDelay?: number;
-    }): this;
-    /**
-     * A write that is undone when time goes back before it: the property is `value` from `at` on, and what it was before otherwise.
-     * `holder` and `id` name the property, so a set and the tweens of the same property are one channel; `write` is the way the caller
-     * writes it (it may do more than assign: redraw), and runs again whenever this set is what the property shows.
-     */
-    setValue<T>(holder: object, id: string, at: number, read: () => T, write: (v: T) => void, value: T): this;
-    /** What the timeline will write, for tools and tests: every segment of this timeline and of the ones under it, starts in this timeline's time. */
-    segments(offset?: number): SegmentInfo[];
-    /** How many timelines are directly under this one. */
-    timelines(): number;
-    duration(): number;
-    time(): number;
-    time(value: number): this;
-    /** GSAP's name for `time(t)`. */
-    seek(t: number): this;
-    progress(): number;
-    progress(p: number): this;
-    kill(): void;
-    /**
-     * What GSAP ended up with once it had been played to the end and back (what Movie used to do at build), as rules that depend
-     * on the segments of a property only:
-     * - a `from` / `fromTo` shows its start from the moment it is built, so a `to` that comes first starts at the start of the
-     *   `from` built last, else at the property's own value;
-     * - a `to` (and a `set`) starts where the segment before it ended;
-     * - a `from` ends where the segment before it ended, or, with none before, where the property was when it was built;
-     * - before the first segment the property shows that segment's start.
-     */
-    private prepare;
-    /** Every channel of this timeline and of its children reads the property it starts from before any of them writes. */
-    private prepareDeep;
-    /** How many channels write each (target, property) in this timeline and everything under it. */
-    private countChannels;
-    private isExclusive;
-    private markExclusive;
-    private evaluate;
-}
-
-/**
- * The timeline of the library and the few things around it: a timeline is a pure function of time (a value at a time is computed from the
- * script and the time alone, never from the way the playhead came), see docs/superpowers/specs/2026-10-10-pure-timeline-design.md.
- */
-type Timeline = PureTimeline;
-
 /** What an author writes in `composition.stops`: a time in seconds, or an object. */
 interface StopSpec {
     /** Where playback stops, in seconds (negative counts back from the end). */
@@ -154,97 +29,6 @@ interface Stop {
     advance?: number;
     pdf?: boolean;
 }
-/**
- * The stops of a composition, checked and in order. Numbers are stops; with no `page` anywhere every stop is a page of its
- * own, otherwise only the stops that say `page` start one (the first stop always does). Negative times count back from the end;
- * two stops on the same frame are one; anything outside the movie or not a number is dropped, with a warning that names it.
- */
-declare function normalizeStops(raw: ReadonlyArray<number | StopSpec> | undefined, duration: number, frameRate: number): Stop[];
-/**
- * The stops whose pictures stand for the pages (`which: 'pages'`, default) or for every stop. A page's picture is, in order: the stop flagged
- * `pdf: true` (the last such one, or the first with `pick: 'first'`), else the last (or first) stop not flagged `pdf: false`, else, for a page
- * list, its last (or first) stop, and for a PDF (`pdf: true` here) nothing: the page is left out. With `which: 'stops'` a PDF leaves out the
- * stops flagged `pdf: false`.
- */
-declare function pictureStops(stops: readonly Stop[], opts?: {
-    which?: 'pages' | 'stops';
-    pick?: 'last' | 'first';
-    pdf?: boolean;
-}): Stop[];
-
-/** One note or chord of a track, as a score reader sees it. */
-interface MusicNote {
-    /** Where it starts: beats from the start, and the same moment in seconds (the tempo map applied; swing and humanize are not). */
-    beat: number;
-    time: number;
-    /** How long it is held, in beats and in seconds. */
-    duration: number;
-    seconds: number;
-    /** The bar it starts in (1-based, from `meter`) and its beat inside that bar (1 = the downbeat, 1.5 = the "and" of 1). */
-    bar: number;
-    beatInBar: number;
-    /** The audible MIDI notes (`music.transpose` and the track's `transpose` are in). */
-    midi: number[];
-    /** What the score called it: `Am7`, `c4`, `[c4 e4 g4]`. */
-    name: string;
-    /** More than one note at once. */
-    chord: boolean;
-    /** 0–1 (0.8 normal, 1 accented with `!`, 0.55 soft with `,`). */
-    velocity: number;
-}
-interface MusicTrackEvents {
-    inst: string;
-    /** The track's length in beats and in bars (not a whole number when a bar is short: that is what to look for). */
-    beats: number;
-    bars: number;
-    notes: MusicNote[];
-}
-interface MusicDrumHit {
-    beat: number;
-    time: number;
-    bar: number;
-    beatInBar: number;
-    velocity: number;
-}
-interface MusicDrumEvents {
-    kind: string;
-    hits: MusicDrumHit[];
-}
-interface MusicEvents {
-    /** The tempo at the start. */
-    bpm: number;
-    meter: number;
-    beats: number;
-    bars: number;
-    /** The music without its reverb tail. */
-    seconds: number;
-    tracks: MusicTrackEvents[];
-    /** Every drum that is hit, over all sections, with every hit written out. */
-    drums: MusicDrumEvents[];
-}
-/** What the `check` tool prints about a music layer: lengths in bars (a short track shows), what starts in each bar, where the drums play. */
-interface MusicSummary {
-    bpm: number;
-    meter: number;
-    /** The score set `meter`; when false 4 is only assumed. */
-    meterSet: boolean;
-    beats: number;
-    bars: number;
-    seconds: number;
-    tail: number;
-    tracks: Array<{
-        inst: string;
-        beats: number;
-        bars: number;
-        events: number;
-        perBar: string[];
-    }>;
-    drums: Array<{
-        from: number;
-        to: number;
-        kinds: string[];
-    }>;
-}
 
 /**
  * pixi-effects public DSL types.
@@ -325,7 +109,7 @@ interface ChromaKeyFilterSpec {
 /**
  * A filter by name: `{ type: 'glow', outerStrength: 3, color: '#ffd166' }`. The type is the filter's class name without
  * `Filter` in camelCase (case does not matter); every other key is the filter's own option. `blur`, `noise`, `alpha` and
- * `colorMatrix` (`preset: 'sepia' | 'grayscale' | …` or a 20-number `matrix`) come from pixi.js; the rest are the filters of
+ * `colorMatrix` (`preset: 'sepia' | 'grayscale' | …` or a 20-number `matrix`) come from pixi.js; `grain` and `warp` are this library's own, the rest are the filters of
  * the `pixi-filters` package (add it to the import map, or `npm i pixi-filters`), loaded on first use. Animate an option with
  * `'filters.<name>.<option>'` like any other filter.
  */
@@ -334,7 +118,7 @@ interface NamedFilterSpec {
     name?: string;
     [option: string]: unknown;
 }
-type NamedFilterType = 'blur' | 'noise' | 'alpha' | 'colorMatrix' | 'grain' | 'adjustment' | 'advancedBloom' | 'ascii' | 'backdropBlur' | 'bevel' | 'bloom' | 'bulgePinch' | 'colorGradient' | 'colorMap' | 'colorOverlay' | 'colorReplace' | 'convolution' | 'crossHatch' | 'crt' | 'dot' | 'dropShadow' | 'emboss' | 'glitch' | 'glow' | 'godray' | 'grayscale' | 'hslAdjustment' | 'kawaseBlur' | 'motionBlur' | 'multiColorReplace' | 'oldFilm' | 'outline' | 'pixelate' | 'radialBlur' | 'reflection' | 'rgbSplit' | 'shockwave' | 'simpleLightmap' | 'simplexNoise' | 'tiltShift' | 'tiltShiftAxis' | 'twist' | 'zoomBlur';
+type NamedFilterType = 'blur' | 'noise' | 'alpha' | 'colorMatrix' | 'grain' | 'warp' | 'adjustment' | 'advancedBloom' | 'ascii' | 'backdropBlur' | 'bevel' | 'bloom' | 'bulgePinch' | 'colorGradient' | 'colorMap' | 'colorOverlay' | 'colorReplace' | 'convolution' | 'crossHatch' | 'crt' | 'dot' | 'dropShadow' | 'emboss' | 'glitch' | 'glow' | 'godray' | 'grayscale' | 'hslAdjustment' | 'kawaseBlur' | 'motionBlur' | 'multiColorReplace' | 'oldFilm' | 'outline' | 'pixelate' | 'radialBlur' | 'reflection' | 'rgbSplit' | 'shockwave' | 'simpleLightmap' | 'simplexNoise' | 'tiltShift' | 'tiltShiftAxis' | 'twist' | 'zoomBlur';
 type FilterSpec = ChromaKeyFilterSpec | CustomFilterSpec | NamedFilterSpec;
 interface TransitionCommon {
     /** Sibling sequence's `name` — the outgoing scene. */
@@ -407,9 +191,12 @@ interface LumaTransition extends TransitionCommon {
 type TransitionSpec = CrossfadeTransition | WipeTransition | IrisTransition | SlideTransition | DipTransition | ZoomTransition | DissolveTransition | LumaTransition;
 /** How a layer blends with what is behind it: the CSS `mix-blend-mode` names, plus `add` and `linear-burn`. */
 type BlendModeName = 'normal' | 'add' | 'screen' | 'multiply' | 'overlay' | 'soft-light' | 'hard-light' | 'color-dodge' | 'color-burn' | 'darken' | 'lighten' | 'difference' | 'exclusion' | 'hue' | 'saturation' | 'color' | 'luminosity' | 'linear-burn';
-/** A matte given by name: another layer of the same composition. `channel` is how it is read (`'alpha'` by default, or `'luma'`: its brightness); `invert` uses 1 − matte. */
+/**
+ * A matte with options: `layer` is another layer of the same composition by name, or a layer written in place. `channel` is how it is read (`'alpha'` by
+ * default, or `'luma'`: its brightness); `invert` uses 1 − matte (a hole instead of a crop). A layer written in place cannot go inside a list.
+ */
 interface MatteRefSpec {
-    layer: string;
+    layer: string | SequenceSpec;
     channel?: 'alpha' | 'luma';
     invert?: boolean;
 }
@@ -457,18 +244,10 @@ interface SequenceCommon {
      * geometric reveals.
      *
      * Instead of a layer written in place, `mask` can name another layer of the same composition (a matte: it is not drawn, and several
-     * layers can share it), `{ layer, channel, invert }`, or a list of those (all of them must let the layer through: intersect; subtract
-     * with `invert: true`).
+     * layers can share it), `{ layer, channel, invert }` (`layer` is a name, or a layer written in place), or a list of names and `{ layer: name }`
+     * (all of them must let the layer through: intersect; subtract with `invert: true`). A hole instead of a crop: `mask: { layer: { …the shape… }, invert: true }`.
      */
     mask?: SequenceSpec | MaskRefSpec | MaskRefSpec[];
-    /**
-     * When true, the mask is inverted: pixels inside the mask shape become
-     * transparent and pixels outside become visible. Useful for "knockout"
-     * effects (cut a hole through an image / panel). Default false.
-     *
-     * Routed through PIXI's native `setMask({ inverse: true })`.
-     */
-    maskInverted?: boolean;
     /**
      * How this layer blends with what is behind it (everything drawn below it). `'add'` and `'screen'` brighten (glows, light
      * leaks, overlapping halos add up instead of covering each other), `'multiply'` darkens; `'overlay'`, `'soft-light'`,
@@ -899,7 +678,7 @@ interface CompositionSpec extends SequenceCommon {
     transitions?: TransitionSpec[];
     /**
      * Where a presentation pauses: seconds, or `{ at, page?, notes?, advance? }` (see `StopSpec`). A stop with `page` begins a page, the others
-     * are steps of it; with no `page` anywhere each stop is a page. Nothing changes for an ordinary player: `Presenter` (and `movie.next()`)
+     * are steps of it; with no `page` anywhere each stop is a page. Nothing changes for an ordinary player: `Presenter` (and `next(movie)`, from `pixi-effects/present`)
      * stop at them, `Controller` shows them as marks on the seek bar.
      */
     stops?: Array<number | StopSpec>;
@@ -914,38 +693,5 @@ interface CompositionShape {
     /** Called after each layer is built (the root shape only): feeds `loadprogress` and lets the page paint now and then. */
     onLayerBuilt?: () => void | Promise<void>;
 }
-/** Audio descriptor pushed to the mixdown queue by AudioSequence/VideoSequence. */
-interface AudioDescriptor {
-    /** Decoded audio (a file or a video's soundtrack). Exactly one of `buffer` / `synth` is set. */
-    buffer?: AudioBuffer;
-    /** Stereo samples (left, right) made on demand at the mix's sample rate (a synthesised sfx). Equal keys render equal samples. */
-    synth?: {
-        key: string;
-        render: (sampleRate: number) => [Float32Array, Float32Array];
-        /** The same samples in slices: `pace(done)` (0..1) runs between them and may wait, so a long piece does not freeze the page. */
-        renderAsync?: (sampleRate: number, pace?: (done: number) => Promise<void> | void) => Promise<[Float32Array, Float32Array]>;
-    };
-    /** Who made it, for warnings and inspectAudio: `layer "pop-1"`. */
-    layer?: string;
-    /** What it plays: `sfx "pop"`, `asset "bgm"`, `video "green"`. */
-    source?: string;
-    /** A music layer's score read back: bars per track, what starts in each bar, the drum spans (for `movie.inspectAudio()` and the `check` tool). */
-    music?: MusicSummary;
-    loop: boolean;
-    start: number;
-    end: number;
-    initialVolume: number;
-    volumeKeyframes: {
-        time: number;
-        value: number;
-    }[];
-    /**
-     * Time remap. `warp` maps the movie's time to the time `start` / `end` / `volumeKeyframes` are measured in (a remapped composition's
-     * local time), NaN where it is silent. `sourceMap` maps that time to a position in the sound (the layer's own speed / `time`); absent:
-     * the sound plays straight from `start`. The mixer resamples through them, so a speed other than 1 changes the pitch.
-     */
-    warp?: (t: number) => number;
-    sourceMap?: (u: number) => number;
-}
 
-export { type SfxPreset as $, type ArcShapeSpec as A, type BlendModeName as B, type CompositionShape as C, type DipTransition as D, type EllipseShapeSpec as E, type FilterSpec as F, type GradientSpec as G, type MusicInstrument as H, type ImageSequenceSpec as I, type MusicLevel as J, type Keyframe as K, type LightSequenceSpec as L, type MusicOptions as M, type MusicNote as N, type MusicSummary as O, type Props as P, type MusicTrack as Q, type MusicTrackEvents as R, type SequenceSpec as S, type TextSequenceSpec as T, type NullSequenceSpec as U, type PathShapeSpec as V, type PolygonShapeSpec as W, type PropValue as X, type RectShapeSpec as Y, type SfxKnobs as Z, type SfxOptions as _, type CameraSequenceSpec as a, type SfxVoice as a0, type ShaderSequenceSpec as a1, type ShapeSequenceSpec as a2, type SlideTransition as a3, type Stop as a4, type StopSpec as a5, type TransitionCommon as a6, type VideoSequenceSpec as a7, type WipeTransition as a8, type ZoomTransition as a9, normalizeStops as aa, pictureStops as ab, type Timeline as ac, type AudioDescriptor as ad, type MusicEvents as b, type TransitionSpec as c, type CompositionSpec as d, type SequenceCommon as e, type AssetSpec as f, type AudioAssetSpec as g, type AudioMusicSpec as h, type AudioSequenceSpec as i, type AudioSfxSpec as j, type ChromaKeyFilterSpec as k, type CircleShapeSpec as l, type CompositionSequenceSpec as m, type CrossfadeTransition as n, type CustomFilterSpec as o, type DissolveTransition as p, type Expr as q, type IrisTransition as r, type LineShapeSpec as s, type LumaTransition as t, type MaskRefSpec as u, type MatteRefSpec as v, type MusicDrum as w, type MusicDrumEvents as x, type MusicDrumHit as y, type MusicDrums as z };
+export type { TransitionCommon as $, ArcShapeSpec as A, BlendModeName as B, CompositionShape as C, DipTransition as D, EllipseShapeSpec as E, FilterSpec as F, GradientSpec as G, PropValue as H, ImageSequenceSpec as I, Props as J, Keyframe as K, LightSequenceSpec as L, MusicOptions as M, NullSequenceSpec as N, SfxKnobs as O, PathShapeSpec as P, SfxOptions as Q, RectShapeSpec as R, SequenceSpec as S, TextSequenceSpec as T, SfxPreset as U, SfxVoice as V, ShaderSequenceSpec as W, ShapeSequenceSpec as X, SlideTransition as Y, Stop as Z, StopSpec as _, CameraSequenceSpec as a, TransitionSpec as a0, VideoSequenceSpec as a1, WipeTransition as a2, ZoomTransition as a3, SequenceCommon as b, AssetSpec as c, AudioAssetSpec as d, AudioMusicSpec as e, AudioSequenceSpec as f, AudioSfxSpec as g, ChromaKeyFilterSpec as h, CircleShapeSpec as i, CompositionSequenceSpec as j, CompositionSpec as k, CrossfadeTransition as l, CustomFilterSpec as m, DissolveTransition as n, Expr as o, IrisTransition as p, LineShapeSpec as q, LumaTransition as r, MaskRefSpec as s, MatteRefSpec as t, MusicDrum as u, MusicDrums as v, MusicInstrument as w, MusicLevel as x, MusicTrack as y, PolygonShapeSpec as z };