etro 0.13.0 → 0.14.0

package/dist/custom-array.d.ts

@@ -1,10 +1,10 @@
-export declare abstract class CustomArrayListener<T> {
-    abstract onAdd(item: T): void;
-    abstract onRemove(item: T): void;
-}
-/**
- * An array that notifies a listener when items are added or removed.
- */
-export declare class CustomArray<T> extends Array<T> {
-    constructor(target: T[], listener: CustomArrayListener<T>);
-}
+export declare abstract class CustomArrayListener<T> {
+    abstract onAdd(item: T): void;
+    abstract onRemove(item: T): void;
+}
+/**
+ * An array that notifies a listener when items are added or removed.
+ */
+export declare class CustomArray<T> extends Array<T> {
+    constructor(target: T[], listener: CustomArrayListener<T>);
+}

package/dist/effect/base.d.ts

@@ -1,60 +1,61 @@
-import { Movie } from '../movie';
-import { Base as BaseLayer } from '../layer/index';
-import BaseObject from '../object';
-/**
- * @deprecated All visual effects now inherit from `Visual` instead
- */
-export declare class Base implements BaseObject {
-    type: string;
-    publicExcludes: string[];
-    propertyFilters: Record<string, <T>(value: T) => T>;
-    enabled: boolean;
-    private _target;
-    /**
-     * The number of times this effect has been attached to a target minus the
-     * number of times it's been detached. (Used for the target's array proxy with
-     * `unshift`)
-     */
-    private _occurrenceCount;
-    constructor();
-    /**
-     * Wait until this effect is ready to be applied
-     */
-    whenReady(): Promise<void>;
-    /**
-     * Attaches this effect to `target` if not already attached.
-     * @ignore
-     */
-    tryAttach(target: Movie | BaseLayer): void;
-    attach(movie: Movie | BaseLayer): void;
-    /**
-     * Detaches this effect from its target if the number of times `tryDetach`
-     * has been called (including this call) equals the number of times
-     * `tryAttach` has been called.
-     *
-     * @ignore
-     */
-    tryDetach(): void;
-    detach(): void;
-    /**
-     * Apply this effect to a target at the given time
-     *
-     * @param target
-     * @param reltime - the movie's current time relative to the layer
-     * (will soon be replaced with an instance getter)
-     * @abstract
-     */
-    apply(target: Movie | BaseLayer, reltime: number): void;
-    /**
-     * The current time of the target
-     */
-    get currentTime(): number;
-    /** `true` if this effect is ready to be applied */
-    get ready(): boolean;
-    get parent(): Movie | BaseLayer;
-    get movie(): Movie;
-    /**
-     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
-     */
-    getDefaultOptions(): Record<string, unknown>;
-}
+import { Movie } from '../movie';
+import { Base as BaseLayer } from '../layer/index';
+import BaseObject from '../object';
+/**
+ * @deprecated All visual effects now inherit from `Visual` instead
+ */
+export declare class Base implements BaseObject {
+    type: string;
+    publicExcludes: string[];
+    propertyFilters: Record<string, <T>(value: T) => T>;
+    enabled: boolean;
+    private _target;
+    /**
+     * The number of times this effect has been attached to a target minus the
+     * number of times it's been detached. (Used for the target's array proxy with
+     * `unshift`)
+     */
+    private _occurrenceCount;
+    constructor();
+    /**
+     * Wait until this effect is ready to be applied
+     */
+    whenReady(): Promise<void>;
+    /**
+     * Attaches this effect to `target` if not already attached.
+     * @ignore
+     */
+    tryAttach(target: Movie | BaseLayer): void;
+    attach(movie: Movie | BaseLayer): void;
+    /**
+     * Detaches this effect from its target if the number of times `tryDetach`
+     * has been called (including this call) equals the number of times
+     * `tryAttach` has been called.
+     *
+     * @ignore
+     */
+    tryDetach(): void;
+    detach(): void;
+    /**
+     * Apply this effect to a target at the given time
+     *
+     * @param target
+     * @param reltime - the movie's current time relative to the layer
+     * (will soon be replaced with an instance getter)
+     * @abstract
+     */
+    apply(target: Movie | BaseLayer, reltime: number): void;
+    /**
+     * The current time of the target
+     */
+    get currentTime(): number;
+    /** `true` if this effect is ready to be applied */
+    get ready(): boolean;
+    get parent(): Movie | BaseLayer;
+    get movie(): Movie;
+    /**
+     * @deprecated See {@link https://github.com/etro-js/etro/issues/131}
+     */
+    getDefaultOptions(): Record<string, unknown>;
+    toJSON(): object;
+}

package/dist/effect/brightness.d.ts

@@ -1,16 +1,16 @@
-import { Dynamic } from '../util';
-import { Shader } from './shader';
-export interface BrightnessOptions {
-    brightness?: Dynamic<number>;
-}
-/**
- * Changes the brightness
- */
-export declare class Brightness extends Shader {
-    brightness: Dynamic<number>;
-    /**
-     * @param [brightness=0] - the value to add to each pixel's color
-     * channels (between -255 and 255)
-     */
-    constructor(options?: BrightnessOptions);
-}
+import { Dynamic } from '../util';
+import { Shader } from './shader';
+export interface BrightnessOptions {
+    brightness?: Dynamic<number>;
+}
+/**
+ * Changes the brightness
+ */
+export declare class Brightness extends Shader {
+    brightness: Dynamic<number>;
+    /**
+     * @param [brightness=0] - the value to add to each pixel's color
+     * channels (between -255 and 255)
+     */
+    constructor(options?: BrightnessOptions);
+}

package/dist/effect/channels.d.ts

@@ -1,23 +1,23 @@
-import { Dynamic } from '../util';
-import { Shader } from './shader';
-export interface ChannelsOptions {
-    factors?: Dynamic<{
-        r?: number;
-        g?: number;
-        b?: number;
-    }>;
-}
-/**
- * Multiplies each channel by a different factor
- */
-export declare class Channels extends Shader {
-    factors: Dynamic<{
-        r?: number;
-        b?: number;
-        g?: number;
-    }>;
-    /**
-     * @param factors - channel factors, each defaulting to 1
-     */
-    constructor(options?: ChannelsOptions);
-}
+import { Dynamic } from '../util';
+import { Shader } from './shader';
+export interface ChannelsOptions {
+    factors?: Dynamic<{
+        r?: number;
+        g?: number;
+        b?: number;
+    }>;
+}
+/**
+ * Multiplies each channel by a different factor
+ */
+export declare class Channels extends Shader {
+    factors: Dynamic<{
+        r?: number;
+        b?: number;
+        g?: number;
+    }>;
+    /**
+     * @param factors - channel factors, each defaulting to 1
+     */
+    constructor(options?: ChannelsOptions);
+}

package/dist/effect/chroma-key.d.ts

@@ -1,23 +1,23 @@
-import { Dynamic, Color } from '../util';
-import { Shader } from './shader';
-export interface ChromaKeyOptions {
-    target?: Dynamic<Color>;
-    threshold?: Dynamic<number>;
-    interpolate?: Dynamic<boolean>;
-}
-/**
- * Reduces alpha for pixels which are close to a specified target color
- */
-export declare class ChromaKey extends Shader {
-    target: Dynamic<Color>;
-    threshold: Dynamic<number>;
-    interpolate: Dynamic<boolean>;
-    /**
-     * @param [target={r: 0, g: 0, b: 0, a: 1}] - the color to remove
-     * @param [threshold=0] - how much error to allow
-     * @param [interpolate=false] - <code>true</code> to interpolate
-     * the alpha channel, or <code>false</code> value for no smoothing (i.e. an
-     * alpha of either 0 or 255)
-     */
-    constructor(options?: ChromaKeyOptions);
-}
+import { Dynamic, Color } from '../util';
+import { Shader } from './shader';
+export interface ChromaKeyOptions {
+    target?: Dynamic<Color>;
+    threshold?: Dynamic<number>;
+    interpolate?: Dynamic<boolean>;
+}
+/**
+ * Reduces alpha for pixels which are close to a specified target color
+ */
+export declare class ChromaKey extends Shader {
+    target: Dynamic<Color>;
+    threshold: Dynamic<number>;
+    interpolate: Dynamic<boolean>;
+    /**
+     * @param [target={r: 0, g: 0, b: 0, a: 1}] - the color to remove
+     * @param [threshold=0] - how much error to allow
+     * @param [interpolate=false] - <code>true</code> to interpolate
+     * the alpha channel, or <code>false</code> value for no smoothing (i.e. an
+     * alpha of either 0 or 255)
+     */
+    constructor(options?: ChromaKeyOptions);
+}

package/dist/effect/contrast.d.ts

@@ -1,15 +1,15 @@
-import { Dynamic } from '../util';
-import { Shader } from './shader';
-export interface ContrastOptions {
-    contrast?: Dynamic<number>;
-}
-/**
- * Changes the contrast by multiplying the RGB channels by a constant
- */
-export declare class Contrast extends Shader {
-    contrast: Dynamic<number>;
-    /**
-     * @param [contrast=1] - the contrast multiplier
-     */
-    constructor(options?: ContrastOptions);
-}
+import { Dynamic } from '../util';
+import { Shader } from './shader';
+export interface ContrastOptions {
+    contrast?: Dynamic<number>;
+}
+/**
+ * Changes the contrast by multiplying the RGB channels by a constant
+ */
+export declare class Contrast extends Shader {
+    contrast: Dynamic<number>;
+    /**
+     * @param [contrast=1] - the contrast multiplier
+     */
+    constructor(options?: ContrastOptions);
+}

package/dist/effect/elliptical-mask.d.ts

@@ -1,31 +1,31 @@
-import { Movie } from '../movie';
-import { Dynamic } from '../util';
-import { Visual } from './visual';
-import { Visual as VisualLayer } from '../layer/index';
-export declare class EllipticalMaskOptions {
-    x: Dynamic<number>;
-    y: Dynamic<number>;
-    radiusX: Dynamic<number>;
-    radiusY: Dynamic<number>;
-    rotation?: Dynamic<number>;
-    startAngle?: Dynamic<number>;
-    endAngle?: Dynamic<number>;
-    anticlockwise?: Dynamic<boolean>;
-}
-/**
- * Preserves an ellipse of the layer and clears the rest
- */
-export declare class EllipticalMask extends Visual {
-    x: Dynamic<number>;
-    y: Dynamic<number>;
-    radiusX: Dynamic<number>;
-    radiusY: Dynamic<number>;
-    rotation: Dynamic<number>;
-    startAngle: Dynamic<number>;
-    endAngle: Dynamic<number>;
-    anticlockwise: Dynamic<boolean>;
-    private _tmpCanvas;
-    private _tmpCtx;
-    constructor(options: EllipticalMaskOptions);
-    apply(target: Movie | VisualLayer, reltime: number): void;
-}
+import { Movie } from '../movie';
+import { Dynamic } from '../util';
+import { Visual } from './visual';
+import { Visual as VisualLayer } from '../layer/index';
+export declare class EllipticalMaskOptions {
+    x: Dynamic<number>;
+    y: Dynamic<number>;
+    radiusX: Dynamic<number>;
+    radiusY: Dynamic<number>;
+    rotation?: Dynamic<number>;
+    startAngle?: Dynamic<number>;
+    endAngle?: Dynamic<number>;
+    anticlockwise?: Dynamic<boolean>;
+}
+/**
+ * Preserves an ellipse of the layer and clears the rest
+ */
+export declare class EllipticalMask extends Visual {
+    x: Dynamic<number>;
+    y: Dynamic<number>;
+    radiusX: Dynamic<number>;
+    radiusY: Dynamic<number>;
+    rotation: Dynamic<number>;
+    startAngle: Dynamic<number>;
+    endAngle: Dynamic<number>;
+    anticlockwise: Dynamic<boolean>;
+    private _tmpCanvas;
+    private _tmpCtx;
+    constructor(options: EllipticalMaskOptions);
+    apply(target: Movie | VisualLayer, reltime: number): void;
+}

package/dist/effect/gaussian-blur.d.ts

@@ -1,60 +1,60 @@
-import { Stack } from './stack';
-import { Shader } from './shader';
-import { Movie } from '../movie';
-import { Visual } from '../layer';
-export interface GaussianBlurOptions {
-    radius: number;
-}
-/**
- * Applies a Gaussian blur
- */
-export declare class GaussianBlur extends Stack {
-    constructor(options: GaussianBlurOptions);
-}
-/**
- * Shared class for both horizontal and vertical gaussian blur classes.
- */
-declare class GaussianBlurComponent extends Shader {
-    radius: number;
-    shape: HTMLCanvasElement;
-    private _radiusCache;
-    /**
-     * @param src - fragment source code (specific to which component -
-     * horizontal or vertical)
-     * @param radius - only integers are currently supported
-     */
-    constructor(options: {
-        fragmentSource: string;
-        radius: number;
-    });
-    apply(target: Movie | Visual, reltime: number): void;
-    /**
-     * Render Gaussian kernel to a canvas for use in shader.
-     * @param kernel
-     * @private
-     *
-     * @return
-     */
-    private static _render1DKernel;
-    private static _gen1DKernel;
-    private static _genPascalRow;
-}
-/**
- * Horizontal component of gaussian blur
- */
-export declare class GaussianBlurHorizontal extends GaussianBlurComponent {
-    /**
-     * @param radius
-     */
-    constructor(options: GaussianBlurOptions);
-}
-/**
- * Vertical component of gaussian blur
- */
-export declare class GaussianBlurVertical extends GaussianBlurComponent {
-    /**
-     * @param radius
-     */
-    constructor(options: GaussianBlurOptions);
-}
-export {};
+import { Stack } from './stack';
+import { Shader } from './shader';
+import { Movie } from '../movie';
+import { Visual } from '../layer';
+export interface GaussianBlurOptions {
+    radius: number;
+}
+/**
+ * Applies a Gaussian blur
+ */
+export declare class GaussianBlur extends Stack {
+    constructor(options: GaussianBlurOptions);
+}
+/**
+ * Shared class for both horizontal and vertical gaussian blur classes.
+ */
+declare class GaussianBlurComponent extends Shader {
+    radius: number;
+    shape: HTMLCanvasElement;
+    private _radiusCache;
+    /**
+     * @param src - fragment source code (specific to which component -
+     * horizontal or vertical)
+     * @param radius - only integers are currently supported
+     */
+    constructor(options: {
+        fragmentSource: string;
+        radius: number;
+    });
+    apply(target: Movie | Visual, reltime: number): void;
+    /**
+     * Render Gaussian kernel to a canvas for use in shader.
+     * @param kernel
+     * @private
+     *
+     * @return
+     */
+    private static _render1DKernel;
+    private static _gen1DKernel;
+    private static _genPascalRow;
+}
+/**
+ * Horizontal component of gaussian blur
+ */
+export declare class GaussianBlurHorizontal extends GaussianBlurComponent {
+    /**
+     * @param radius
+     */
+    constructor(options: GaussianBlurOptions);
+}
+/**
+ * Vertical component of gaussian blur
+ */
+export declare class GaussianBlurVertical extends GaussianBlurComponent {
+    /**
+     * @param radius
+     */
+    constructor(options: GaussianBlurOptions);
+}
+export {};

package/dist/effect/grayscale.d.ts

@@ -1,7 +1,7 @@
-import { Shader } from './shader';
-/**
- * Converts the target to a grayscale image
- */
-export declare class Grayscale extends Shader {
-    constructor();
-}
+import { Shader } from './shader';
+/**
+ * Converts the target to a grayscale image
+ */
+export declare class Grayscale extends Shader {
+    constructor();
+}

package/dist/effect/index.d.ts

@@ -1,16 +1,16 @@
-/**
- * @module effect
- */
-export * from './base';
-export * from './brightness';
-export * from './channels';
-export * from './chroma-key';
-export * from './contrast';
-export * from './elliptical-mask';
-export * from './gaussian-blur';
-export * from './grayscale';
-export * from './pixelate';
-export * from './shader';
-export * from './stack';
-export * from './transform';
-export * from './visual';
+/**
+ * @module effect
+ */
+export * from './base';
+export * from './brightness';
+export * from './channels';
+export * from './chroma-key';
+export * from './contrast';
+export * from './elliptical-mask';
+export * from './gaussian-blur';
+export * from './grayscale';
+export * from './pixelate';
+export * from './shader';
+export * from './stack';
+export * from './transform';
+export * from './visual';

package/dist/effect/pixelate.d.ts

@@ -1,18 +1,18 @@
-import { Visual } from '../layer';
-import { Movie } from '../movie';
-import { Dynamic } from '../util';
-import { Shader } from './shader';
-export interface PixelateOptions {
-    pixelSize?: Dynamic<number>;
-}
-/**
- * Breaks the target up into squares of `pixelSize` by `pixelSize`
- */
-export declare class Pixelate extends Shader {
-    pixelSize: Dynamic<number>;
-    /**
-     * @param pixelSize
-     */
-    constructor(options?: PixelateOptions);
-    apply(target: Movie | Visual, reltime: number): void;
-}
+import { Visual } from '../layer';
+import { Movie } from '../movie';
+import { Dynamic } from '../util';
+import { Shader } from './shader';
+export interface PixelateOptions {
+    pixelSize?: Dynamic<number>;
+}
+/**
+ * Breaks the target up into squares of `pixelSize` by `pixelSize`
+ */
+export declare class Pixelate extends Shader {
+    pixelSize: Dynamic<number>;
+    /**
+     * @param pixelSize
+     */
+    constructor(options?: PixelateOptions);
+    apply(target: Movie | Visual, reltime: number): void;
+}