pixi-effects 0.2.0 → 0.4.0

package/dist/Movie-CghFXprP.d.cts

@@ -0,0 +1,179 @@
+import { Application } from 'pixi.js';
+import { gsap } from 'gsap';
+import { A as AssetSpec, g as CompositionSpec } from './types-CRE9WKd4.cjs';
+
+interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface LayerInfo {
+    /** Names (or `type#index`) from the root, joined by `/`. */
+    path: string;
+    name?: string;
+    type: string;
+    threeD: boolean;
+    /** Alive at this frame, not hidden by an ancestor, and alpha > 0. */
+    visible: boolean;
+    alpha: number;
+    /** Its `x` or `y` is animated: text that moves across the canvas on purpose (a ticker) is not reported as cut off. */
+    moving: boolean;
+    /** Where it is drawn, in canvas pixels. `null` inside a `threeD` layer (it is rendered into that layer's texture). */
+    bounds: Rect | null;
+    onCanvas: 'full' | 'partial' | 'none' | null;
+}
+interface InspectReport {
+    frame: number;
+    time: number;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    /** Layer counts (of the whole tree) — present even when `layers` is filtered out. */
+    summary: {
+        layers: number;
+        visible: number;
+    };
+    /** Human-readable problems worth a look: text off-canvas / cut off / empty / overlapping text. Read this first. */
+    issues: string[];
+    layers: LayerInfo[];
+}
+interface InspectOptions {
+    /** Which layers to list: every layer, only those drawn at this frame, or none (just `issues` + `summary`). Default `'all'`. */
+    layers?: 'all' | 'visible' | 'none';
+}
+
+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 SnapshotOptions {
+    /** Output size relative to the canvas (default 1). */
+    scale?: number;
+    /** `'image/png'` (default) or `'image/jpeg'`. */
+    type?: 'image/png' | 'image/jpeg';
+    /** Return a `data:` URL string instead of a Blob (handy for scripts that can only return text). */
+    as?: 'blob' | 'dataURL';
+}
+interface ContactSheetOptions {
+    /** Frames to show. Default: `count` frames spread evenly over the movie. */
+    frames?: number[];
+    /** Times in seconds to show (used when `frames` is not given). */
+    times?: number[];
+    /** How many frames when neither `frames` nor `times` is given. Default 6. */
+    count?: number;
+    /** Columns in the grid. Default 3. */
+    columns?: number;
+    /** Width of each picture in pixels. Default 480. */
+    cellWidth?: number;
+    as?: 'blob' | 'dataURL';
+}
+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;
+    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;
+    /**
+     * A picture of one frame (the canvas only: the player bar is not included). Seeks there first and
+     * stays there. Use it to LOOK at your composition.
+     */
+    snapshot(frame?: number, opts?: SnapshotOptions & {
+        as?: 'blob';
+    }): Promise<Blob>;
+    snapshot(frame: number | undefined, opts: SnapshotOptions & {
+        as: 'dataURL';
+    }): Promise<string>;
+    /**
+     * Several frames on ONE image, each labelled with its frame number and time — the cheapest way to
+     * check a whole animation by eye. Restores the current frame afterwards.
+     */
+    contactSheet(opts?: ContactSheetOptions & {
+        as?: 'blob';
+    }): Promise<Blob>;
+    contactSheet(opts: ContactSheetOptions & {
+        as: 'dataURL';
+    }): Promise<string>;
+    /**
+     * Where every layer is drawn at `frame` (canvas pixels, visibility) plus `issues` — text that is off
+     * the canvas, cut by an edge, empty, or overlapping other text. Seeks there and stays there.
+     */
+    inspect(frame?: number, opts?: InspectOptions): Promise<InspectReport>;
+    /**
+     * Draw the stage now. PixiJS's CullerPlugin only culls inside `app.render()` (the ticker), and we render
+     * by hand — while seeking and especially during `render()`, which stops the ticker — so without this the
+     * `culled` flags are whatever the last tick left: a layer that is now on screen can stay culled and be
+     * missing from the frame or from the exported video. Cull again (updating transforms: the timeline just
+     * moved things) right before drawing.
+     */
+    private _renderNow;
+    private _requireReady;
+    /** Projects every `threeD` layer for the current frame (see src/space). */
+    private _updateSpace;
+    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>;
+}
+
+export { type ContactSheetOptions as C, type FrameEvent as F, type InspectOptions as I, type LayerInfo as L, Movie as M, type ProgressEvent as P, type RenderOptions as R, type SnapshotOptions as S, type InspectReport as a, type MovieOptions as b };

package/dist/Movie-DRZtIGU7.d.ts

@@ -0,0 +1,179 @@
+import { Application } from 'pixi.js';
+import { gsap } from 'gsap';
+import { A as AssetSpec, g as CompositionSpec } from './types-CRE9WKd4.js';
+
+interface Rect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+interface LayerInfo {
+    /** Names (or `type#index`) from the root, joined by `/`. */
+    path: string;
+    name?: string;
+    type: string;
+    threeD: boolean;
+    /** Alive at this frame, not hidden by an ancestor, and alpha > 0. */
+    visible: boolean;
+    alpha: number;
+    /** Its `x` or `y` is animated: text that moves across the canvas on purpose (a ticker) is not reported as cut off. */
+    moving: boolean;
+    /** Where it is drawn, in canvas pixels. `null` inside a `threeD` layer (it is rendered into that layer's texture). */
+    bounds: Rect | null;
+    onCanvas: 'full' | 'partial' | 'none' | null;
+}
+interface InspectReport {
+    frame: number;
+    time: number;
+    canvas: {
+        width: number;
+        height: number;
+    };
+    /** Layer counts (of the whole tree) — present even when `layers` is filtered out. */
+    summary: {
+        layers: number;
+        visible: number;
+    };
+    /** Human-readable problems worth a look: text off-canvas / cut off / empty / overlapping text. Read this first. */
+    issues: string[];
+    layers: LayerInfo[];
+}
+interface InspectOptions {
+    /** Which layers to list: every layer, only those drawn at this frame, or none (just `issues` + `summary`). Default `'all'`. */
+    layers?: 'all' | 'visible' | 'none';
+}
+
+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 SnapshotOptions {
+    /** Output size relative to the canvas (default 1). */
+    scale?: number;
+    /** `'image/png'` (default) or `'image/jpeg'`. */
+    type?: 'image/png' | 'image/jpeg';
+    /** Return a `data:` URL string instead of a Blob (handy for scripts that can only return text). */
+    as?: 'blob' | 'dataURL';
+}
+interface ContactSheetOptions {
+    /** Frames to show. Default: `count` frames spread evenly over the movie. */
+    frames?: number[];
+    /** Times in seconds to show (used when `frames` is not given). */
+    times?: number[];
+    /** How many frames when neither `frames` nor `times` is given. Default 6. */
+    count?: number;
+    /** Columns in the grid. Default 3. */
+    columns?: number;
+    /** Width of each picture in pixels. Default 480. */
+    cellWidth?: number;
+    as?: 'blob' | 'dataURL';
+}
+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;
+    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;
+    /**
+     * A picture of one frame (the canvas only: the player bar is not included). Seeks there first and
+     * stays there. Use it to LOOK at your composition.
+     */
+    snapshot(frame?: number, opts?: SnapshotOptions & {
+        as?: 'blob';
+    }): Promise<Blob>;
+    snapshot(frame: number | undefined, opts: SnapshotOptions & {
+        as: 'dataURL';
+    }): Promise<string>;
+    /**
+     * Several frames on ONE image, each labelled with its frame number and time — the cheapest way to
+     * check a whole animation by eye. Restores the current frame afterwards.
+     */
+    contactSheet(opts?: ContactSheetOptions & {
+        as?: 'blob';
+    }): Promise<Blob>;
+    contactSheet(opts: ContactSheetOptions & {
+        as: 'dataURL';
+    }): Promise<string>;
+    /**
+     * Where every layer is drawn at `frame` (canvas pixels, visibility) plus `issues` — text that is off
+     * the canvas, cut by an edge, empty, or overlapping other text. Seeks there and stays there.
+     */
+    inspect(frame?: number, opts?: InspectOptions): Promise<InspectReport>;
+    /**
+     * Draw the stage now. PixiJS's CullerPlugin only culls inside `app.render()` (the ticker), and we render
+     * by hand — while seeking and especially during `render()`, which stops the ticker — so without this the
+     * `culled` flags are whatever the last tick left: a layer that is now on screen can stay culled and be
+     * missing from the frame or from the exported video. Cull again (updating transforms: the timeline just
+     * moved things) right before drawing.
+     */
+    private _renderNow;
+    private _requireReady;
+    /** Projects every `threeD` layer for the current frame (see src/space). */
+    private _updateSpace;
+    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>;
+}
+
+export { type ContactSheetOptions as C, type FrameEvent as F, type InspectOptions as I, type LayerInfo as L, Movie as M, type ProgressEvent as P, type RenderOptions as R, type SnapshotOptions as S, type InspectReport as a, type MovieOptions as b };