@luma.gl/engine 9.0.0-alpha.9 → 9.0.0-beta.10

package/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2020 Urban Computing Foundation
+luma.gl is provided under the MIT license
+
+Copyright (c) 2020 vis.gl contributors
 
 This software includes parts initially developed by Uber and open sourced under MIT license.
 Copyright (c) 2015 Uber Technologies, Inc.

package/dist/animation/key-frames.d.ts

@@ -1,4 +1,4 @@
-export declare type KeyFrame<T> = [number, T];
+export type KeyFrame<T> = [number, T];
 /** Holds a list of key frames (timestamped values) */
 export declare class KeyFrames<T = number> {
     startIndex: number;

package/dist/animation/key-frames.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key-frames.d.ts","sourceRoot":"","sources":["../../src/animation/key-frames.ts"],"names":[],"mappings":"AACA,oBAAY,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAEtC,sDAAsD;AACtD,qBAAa,SAAS,CAAC,CAAC,GAAG,MAAM;IAC/B,UAAU,EAAE,MAAM,CAAM;IACxB,QAAQ,EAAE,MAAM,CAAM;IACtB,MAAM,EAAE,MAAM,CAAK;IACnB,KAAK,EAAE,MAAM,EAAE,CAAM;IACrB,MAAM,EAAE,CAAC,EAAE,CAAM;IACjB,OAAO,CAAC,SAAS,CAAM;gBAEX,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE;IAKpC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAa5C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS3B,YAAY,IAAI,MAAM;IAItB,UAAU,IAAI,MAAM;IAIpB,YAAY,IAAI,CAAC;IAIjB,UAAU,IAAI,CAAC;IAIf,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAiBnC"}
+{"version":3,"file":"key-frames.d.ts","sourceRoot":"","sources":["../../src/animation/key-frames.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;AAEtC,sDAAsD;AACtD,qBAAa,SAAS,CAAC,CAAC,GAAG,MAAM;IAC/B,UAAU,EAAE,MAAM,CAAM;IACxB,QAAQ,EAAE,MAAM,CAAM;IACtB,MAAM,EAAE,MAAM,CAAK;IACnB,KAAK,EAAE,MAAM,EAAE,CAAM;IACrB,MAAM,EAAE,CAAC,EAAE,CAAM;IACjB,OAAO,CAAC,SAAS,CAAM;gBAEX,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE;IAKpC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI;IAa5C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAS3B,YAAY,IAAI,MAAM;IAItB,UAAU,IAAI,MAAM;IAIpB,YAAY,IAAI,CAAC;IAIjB,UAAU,IAAI,CAAC;IAIf,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;CAiBnC"}

package/dist/animation/key-frames.js

@@ -1,77 +1,56 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+/** Holds a list of key frames (timestamped values) */
 export class KeyFrames {
-  constructor(keyFrames) {
-    _defineProperty(this, "startIndex", -1);
-
-    _defineProperty(this, "endIndex", -1);
-
-    _defineProperty(this, "factor", 0);
-
-    _defineProperty(this, "times", []);
-
-    _defineProperty(this, "values", []);
-
-    _defineProperty(this, "_lastTime", -1);
-
-    this.setKeyFrames(keyFrames);
-    this.setTime(0);
-  }
-
-  setKeyFrames(keyFrames) {
-    const numKeys = keyFrames.length;
-    this.times.length = numKeys;
-    this.values.length = numKeys;
-
-    for (let i = 0; i < numKeys; ++i) {
-      this.times[i] = keyFrames[i][0];
-      this.values[i] = keyFrames[i][1];
+    startIndex = -1;
+    endIndex = -1;
+    factor = 0;
+    times = [];
+    values = [];
+    _lastTime = -1;
+    constructor(keyFrames) {
+        this.setKeyFrames(keyFrames);
+        this.setTime(0);
     }
-
-    this._calculateKeys(this._lastTime);
-  }
-
-  setTime(time) {
-    time = Math.max(0, time);
-
-    if (time !== this._lastTime) {
-      this._calculateKeys(time);
-
-      this._lastTime = time;
+    setKeyFrames(keyFrames) {
+        const numKeys = keyFrames.length;
+        this.times.length = numKeys;
+        this.values.length = numKeys;
+        for (let i = 0; i < numKeys; ++i) {
+            this.times[i] = keyFrames[i][0];
+            this.values[i] = keyFrames[i][1];
+        }
+        this._calculateKeys(this._lastTime);
     }
-  }
-
-  getStartTime() {
-    return this.times[this.startIndex];
-  }
-
-  getEndTime() {
-    return this.times[this.endIndex];
-  }
-
-  getStartData() {
-    return this.values[this.startIndex];
-  }
-
-  getEndData() {
-    return this.values[this.endIndex];
-  }
-
-  _calculateKeys(time) {
-    let index = 0;
-    const numKeys = this.times.length;
-
-    for (index = 0; index < numKeys - 2; ++index) {
-      if (this.times[index + 1] > time) {
-        break;
-      }
+    setTime(time) {
+        time = Math.max(0, time);
+        if (time !== this._lastTime) {
+            this._calculateKeys(time);
+            this._lastTime = time;
+        }
+    }
+    getStartTime() {
+        return this.times[this.startIndex];
+    }
+    getEndTime() {
+        return this.times[this.endIndex];
+    }
+    getStartData() {
+        return this.values[this.startIndex];
+    }
+    getEndData() {
+        return this.values[this.endIndex];
+    }
+    _calculateKeys(time) {
+        let index = 0;
+        const numKeys = this.times.length;
+        for (index = 0; index < numKeys - 2; ++index) {
+            if (this.times[index + 1] > time) {
+                break;
+            }
+        }
+        this.startIndex = index;
+        this.endIndex = index + 1;
+        const startTime = this.times[this.startIndex];
+        const endTime = this.times[this.endIndex];
+        this.factor = Math.min(Math.max(0, (time - startTime) / (endTime - startTime)), 1);
     }
-
-    this.startIndex = index;
-    this.endIndex = index + 1;
-    const startTime = this.times[this.startIndex];
-    const endTime = this.times[this.endIndex];
-    this.factor = Math.min(Math.max(0, (time - startTime) / (endTime - startTime)), 1);
-  }
-
 }
-//# sourceMappingURL=key-frames.js.map

package/dist/animation/timeline.d.ts

@@ -5,23 +5,23 @@
  * @param rate = 1
  * @param repeat = 1
  */
-export declare type ChannelOptions = {
+export type ChannelOptions = {
     delay?: number;
     duration?: number;
     rate?: number;
     repeat?: number;
 };
-export declare type AnimationOptions = {
+export type AnimationOptions = {
     setTime: (time: number) => void;
 };
-declare type Channel = {
+type Channel = {
     time: number;
     delay: number;
     duration: number;
     rate: number;
     repeat: number;
 };
-declare type Animation = {
+type Animation = {
     channel?: number;
     animation: {
         setTime: (time: number) => void;
@@ -35,15 +35,15 @@ export declare class Timeline {
     lastEngineTime: number;
     constructor();
     addChannel(props: ChannelOptions): number;
-    removeChannel(handle: number): void;
-    isFinished(handle: number): boolean;
-    getTime(handle?: number): number;
+    removeChannel(channelId: number): void;
+    isFinished(channelId: number): boolean;
+    getTime(channelId?: number): number;
     setTime(time: number): void;
     play(): void;
     pause(): void;
     reset(): void;
     attachAnimation(animation: AnimationOptions, channelHandle?: number): number;
-    detachAnimation(handle: number): void;
+    detachAnimation(channelId: number): void;
     update(engineTime: number): void;
     _setChannelTime(channel: Channel, time: number): void;
 }

package/dist/animation/timeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"timeline.d.ts","sourceRoot":"","sources":["../../src/animation/timeline.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACF,oBAAY,cAAc,GAAG;IAC5B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,oBAAY,gBAAgB,GAAG;IAC7B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAChC,CAAA;AAEA,aAAK,OAAO,GAAG;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,aAAK,SAAS,GAAG;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;KAChC,CAAA;CACF,CAAA;AAKD,qBAAa,QAAQ;IACnB,IAAI,EAAE,MAAM,CAAK;IACjB,QAAQ,uBAA8B;IACtC,UAAU,yBAAgC;IAC1C,OAAO,EAAE,OAAO,CAAS;IACzB,cAAc,EAAE,MAAM,CAAM;;IAK5B,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;IAiBzC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAUnC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IASnC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM;IAchC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAe3B,IAAI,IAAI,IAAI;IAIZ,KAAK,IAAI,IAAI;IAKb,KAAK,IAAI,IAAI;IAIb,eAAe,CAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;IAa5E,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIrC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAUhC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAWtD"}
+{"version":3,"file":"timeline.d.ts","sourceRoot":"","sources":["../../src/animation/timeline.ts"],"names":[],"mappings":"AAIA;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC,CAAC;AAEF,KAAK,OAAO,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,SAAS,GAAG;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE;QACT,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;KACjC,CAAC;CACH,CAAC;AAKF,qBAAa,QAAQ;IACnB,IAAI,EAAE,MAAM,CAAK;IACjB,QAAQ,uBAA8B;IACtC,UAAU,yBAAgC;IAC1C,OAAO,EAAE,OAAO,CAAS;IACzB,cAAc,EAAE,MAAM,CAAM;;IAI5B,UAAU,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;IAiBzC,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAUtC,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAStC,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM;IAcnC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAe3B,IAAI,IAAI,IAAI;IAIZ,KAAK,IAAI,IAAI;IAKb,KAAK,IAAI,IAAI;IAIb,eAAe,CAAC,SAAS,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM;IAa5E,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAIxC,MAAM,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAUhC,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;CAWtD"}

package/dist/animation/timeline.js

@@ -1,143 +1,107 @@
-import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
+// luma.gl
+// SPDX-License-Identifier: MIT
+// Copyright (c) vis.gl contributors
 let channelHandles = 1;
 let animationHandles = 1;
 export class Timeline {
-  constructor() {
-    _defineProperty(this, "time", 0);
-
-    _defineProperty(this, "channels", new Map());
-
-    _defineProperty(this, "animations", new Map());
-
-    _defineProperty(this, "playing", false);
-
-    _defineProperty(this, "lastEngineTime", -1);
-  }
-
-  addChannel(props) {
-    const {
-      delay = 0,
-      duration = Number.POSITIVE_INFINITY,
-      rate = 1,
-      repeat = 1
-    } = props;
-    const handle = channelHandles++;
-    const channel = {
-      time: 0,
-      delay,
-      duration,
-      rate,
-      repeat
-    };
-
-    this._setChannelTime(channel, this.time);
-
-    this.channels.set(handle, channel);
-    return handle;
-  }
-
-  removeChannel(handle) {
-    this.channels.delete(handle);
-
-    for (const [animationHandle, animation] of this.animations) {
-      if (animation.channel === handle) {
-        this.detachAnimation(animationHandle);
-      }
+    time = 0;
+    channels = new Map();
+    animations = new Map();
+    playing = false;
+    lastEngineTime = -1;
+    constructor() { }
+    addChannel(props) {
+        const { delay = 0, duration = Number.POSITIVE_INFINITY, rate = 1, repeat = 1 } = props;
+        const channelId = channelHandles++;
+        const channel = {
+            time: 0,
+            delay,
+            duration,
+            rate,
+            repeat
+        };
+        this._setChannelTime(channel, this.time);
+        this.channels.set(channelId, channel);
+        return channelId;
     }
-  }
-
-  isFinished(handle) {
-    const channel = this.channels.get(handle);
-
-    if (channel === undefined) {
-      return false;
+    removeChannel(channelId) {
+        this.channels.delete(channelId);
+        for (const [animationHandle, animation] of this.animations) {
+            if (animation.channel === channelId) {
+                this.detachAnimation(animationHandle);
+            }
+        }
     }
-
-    return this.time >= channel.delay + channel.duration * channel.repeat;
-  }
-
-  getTime(handle) {
-    if (handle === undefined) {
-      return this.time;
+    isFinished(channelId) {
+        const channel = this.channels.get(channelId);
+        if (channel === undefined) {
+            return false;
+        }
+        return this.time >= channel.delay + channel.duration * channel.repeat;
     }
-
-    const channel = this.channels.get(handle);
-
-    if (channel === undefined) {
-      return -1;
+    getTime(channelId) {
+        if (channelId === undefined) {
+            return this.time;
+        }
+        const channel = this.channels.get(channelId);
+        if (channel === undefined) {
+            return -1;
+        }
+        return channel.time;
     }
-
-    return channel.time;
-  }
-
-  setTime(time) {
-    this.time = Math.max(0, time);
-    const channels = this.channels.values();
-
-    for (const channel of channels) {
-      this._setChannelTime(channel, this.time);
+    setTime(time) {
+        this.time = Math.max(0, time);
+        const channels = this.channels.values();
+        for (const channel of channels) {
+            this._setChannelTime(channel, this.time);
+        }
+        const animations = this.animations.values();
+        for (const animationData of animations) {
+            const { animation, channel } = animationData;
+            animation.setTime(this.getTime(channel));
+        }
     }
-
-    const animations = this.animations.values();
-
-    for (const animationData of animations) {
-      const {
-        animation,
-        channel
-      } = animationData;
-      animation.setTime(this.getTime(channel));
+    play() {
+        this.playing = true;
     }
-  }
-
-  play() {
-    this.playing = true;
-  }
-
-  pause() {
-    this.playing = false;
-    this.lastEngineTime = -1;
-  }
-
-  reset() {
-    this.setTime(0);
-  }
-
-  attachAnimation(animation, channelHandle) {
-    const animationHandle = animationHandles++;
-    this.animations.set(animationHandle, {
-      animation,
-      channel: channelHandle
-    });
-    animation.setTime(this.getTime(channelHandle));
-    return animationHandle;
-  }
-
-  detachAnimation(handle) {
-    this.animations.delete(handle);
-  }
-
-  update(engineTime) {
-    if (this.playing) {
-      if (this.lastEngineTime === -1) {
-        this.lastEngineTime = engineTime;
-      }
-
-      this.setTime(this.time + (engineTime - this.lastEngineTime));
-      this.lastEngineTime = engineTime;
+    pause() {
+        this.playing = false;
+        this.lastEngineTime = -1;
     }
-  }
-
-  _setChannelTime(channel, time) {
-    const offsetTime = time - channel.delay;
-    const totalDuration = channel.duration * channel.repeat;
-
-    if (offsetTime >= totalDuration) {
-      channel.time = channel.duration * channel.rate;
-    } else {
-      channel.time = Math.max(0, offsetTime) % channel.duration;
-      channel.time *= channel.rate;
+    reset() {
+        this.setTime(0);
+    }
+    attachAnimation(animation, channelHandle) {
+        const animationHandle = animationHandles++;
+        this.animations.set(animationHandle, {
+            animation,
+            channel: channelHandle
+        });
+        animation.setTime(this.getTime(channelHandle));
+        return animationHandle;
+    }
+    detachAnimation(channelId) {
+        this.animations.delete(channelId);
+    }
+    update(engineTime) {
+        if (this.playing) {
+            if (this.lastEngineTime === -1) {
+                this.lastEngineTime = engineTime;
+            }
+            this.setTime(this.time + (engineTime - this.lastEngineTime));
+            this.lastEngineTime = engineTime;
+        }
+    }
+    _setChannelTime(channel, time) {
+        const offsetTime = time - channel.delay;
+        const totalDuration = channel.duration * channel.repeat;
+        // Note(Tarek): Don't loop on final repeat.
+        if (offsetTime >= totalDuration) {
+            channel.time = channel.duration * channel.rate;
+        }
+        else {
+            channel.time = Math.max(0, offsetTime) % channel.duration;
+            channel.time *= channel.rate;
+        }
     }
-  }
-
 }
-//# sourceMappingURL=timeline.js.map

package/dist/animation-loop/animation-loop-template.d.ts

@@ -0,0 +1,23 @@
+import type { AnimationProps } from "./animation-props.js";
+/**
+ * Minimal class that represents a "componentized" rendering life cycle
+ * (resource construction, repeated rendering, resource destruction)
+ *
+ * @note A motivation for this class compared to the raw animation loop is
+ * that it simplifies TypeScript code by allowing resources to be typed unconditionally
+ * since they are allocated in the constructor rather than in onInitialized
+ *
+ * @note Introduced in luma.gl v9
+ *
+ * @example AnimationLoopTemplate is intended to be subclassed,
+ * but the subclass should not be instantiated directly. Instead the subclass
+ * (i.e. the constructor of the subclass) should be used
+ * as an argument to create an AnimationLoop.
+ */
+export declare abstract class AnimationLoopTemplate {
+    constructor(animationProps?: AnimationProps);
+    onInitialize(animationProps: AnimationProps): Promise<unknown>;
+    abstract onRender(animationProps: AnimationProps): unknown;
+    abstract onFinalize(animationProps: AnimationProps): void;
+}
+//# sourceMappingURL=animation-loop-template.d.ts.map

package/dist/animation-loop/animation-loop-template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"animation-loop-template.d.ts","sourceRoot":"","sources":["../../src/animation-loop/animation-loop-template.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,6BAA0B;AAEtD;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,qBAAqB;gBAC7B,cAAc,CAAC,EAAE,cAAc;IACrC,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAGpE,QAAQ,CAAC,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,OAAO;IAC1D,QAAQ,CAAC,UAAU,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;CAC1D"}

package/dist/animation-loop/animation-loop-template.js

@@ -0,0 +1,21 @@
+/**
+ * Minimal class that represents a "componentized" rendering life cycle
+ * (resource construction, repeated rendering, resource destruction)
+ *
+ * @note A motivation for this class compared to the raw animation loop is
+ * that it simplifies TypeScript code by allowing resources to be typed unconditionally
+ * since they are allocated in the constructor rather than in onInitialized
+ *
+ * @note Introduced in luma.gl v9
+ *
+ * @example AnimationLoopTemplate is intended to be subclassed,
+ * but the subclass should not be instantiated directly. Instead the subclass
+ * (i.e. the constructor of the subclass) should be used
+ * as an argument to create an AnimationLoop.
+ */
+export class AnimationLoopTemplate {
+    constructor(animationProps) { }
+    async onInitialize(animationProps) {
+        return null;
+    }
+}

package/dist/{lib → animation-loop}/animation-loop.d.ts

@@ -1,20 +1,21 @@
-/// <reference types="offscreencanvas" />
-import { Device, DeviceProps } from '@luma.gl/api';
-import { Timeline } from '../animation/timeline';
-import { AnimationProps } from '../lib/animation-props';
+import { Device } from '@luma.gl/core';
+import { Timeline } from "../animation/timeline.js";
+import { AnimationProps } from "./animation-props.js";
 import { Stats, Stat } from '@probe.gl/stats';
 /** AnimationLoop properties */
-export declare type AnimationLoopProps = {
-    onCreateDevice?: (props: DeviceProps) => Promise<Device>;
+export type AnimationLoopProps = {
+    device: Device | Promise<Device>;
     onAddHTML?: (div: HTMLDivElement) => string;
-    onInitialize?: (animationProps: AnimationProps) => void;
-    onRender?: (animationProps: AnimationProps) => void;
+    onInitialize?: (animationProps: AnimationProps) => Promise<unknown>;
+    onRender?: (animationProps: AnimationProps) => unknown;
     onFinalize?: (animationProps: AnimationProps) => void;
     onError?: (reason: Error) => void;
-    device?: Device | null;
-    deviceProps?: DeviceProps;
     stats?: Stats;
-    debug?: boolean;
+    autoResizeViewport?: boolean;
+    autoResizeDrawingBuffer?: boolean;
+    useDevicePixels?: number | boolean;
+};
+export type MutableAnimationLoopProps = {
     autoResizeViewport?: boolean;
     autoResizeDrawingBuffer?: boolean;
     useDevicePixels?: number | boolean;
@@ -36,36 +37,43 @@ export declare class AnimationLoop {
     _running: boolean;
     _animationFrameId: any;
     _nextFramePromise: Promise<AnimationLoop> | null;
-    _resolveNextFrame: ((AnimationLoop: any) => void) | null;
+    _resolveNextFrame: ((animationLoop: AnimationLoop) => void) | null;
     _cpuStartTime: number;
-    constructor(props?: AnimationLoopProps);
+    constructor(props: AnimationLoopProps);
     destroy(): void;
     /** @deprecated Use .destroy() */
     delete(): void;
+    /** Flags this animation loop as needing redraw */
     setNeedsRedraw(reason: string): this;
-    setProps(props: AnimationLoopProps): this;
+    /** TODO - move these props to CanvasContext? */
+    setProps(props: MutableAnimationLoopProps): this;
     /** Starts a render loop if not already running */
-    start(): Promise<this | null>;
+    start(): Promise<this>;
+    /** Stops a render loop if already running, finalizing */
+    stop(): this;
     /** Explicitly draw a frame */
     redraw(): this;
-    stop(): this;
+    /** Add a timeline, it will be automatically updated by the animation loop. */
     attachTimeline(timeline: Timeline): Timeline;
+    /** Remove a timeline */
     detachTimeline(): void;
+    /** Wait until a render completes */
     waitForRender(): Promise<AnimationLoop>;
+    /** TODO - should use device.deviceContext */
     toDataURL(): Promise<string>;
     _initialize(): void;
     _setDisplay(display: any): void;
     _requestAnimationFrame(): void;
     _cancelAnimationFrame(): void;
     _animationFrame(): void;
-    _renderFrame(props: AnimationProps): void;
+    _renderFrame(animationProps: AnimationProps): void;
     _clearNeedsRedraw(): void;
     _setupFrame(): void;
     _initializeAnimationProps(): void;
     _getAnimationProps(): AnimationProps;
     _updateAnimationProps(): void;
-    /** Either uses supplied or existing context, or calls provided callback to create one */
-    _createDevice(): Promise<void>;
+    /** Wait for supplied device */
+    _initDevice(): Promise<void>;
     _createInfoDiv(): void;
     _getSizeAndAspect(): {
         width: number;
@@ -79,10 +87,10 @@ export declare class AnimationLoop {
      * Optionally multiplying with devicePixel ratio
      */
     _resizeCanvasDrawingBuffer(): void;
-    _beginTimers(): void;
-    _endTimers(): void;
+    _beginFrameTimers(): void;
+    _endFrameTimers(): void;
     _startEventHandling(): void;
-    _onMousemove(e: any): void;
-    _onMouseleave(e: any): void;
+    _onMousemove(event: Event): void;
+    _onMouseleave(event: Event): void;
 }
 //# sourceMappingURL=animation-loop.d.ts.map

package/dist/animation-loop/animation-loop.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"animation-loop.d.ts","sourceRoot":"","sources":["../../src/animation-loop/animation-loop.ts"],"names":[],"mappings":"AAIA,OAAO,EAAO,MAAM,EAAC,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAC,QAAQ,EAAC,iCAA8B;AAC/C,OAAO,EAAC,cAAc,EAAC,6BAA0B;AACjD,OAAO,EAAC,KAAK,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAI5C,+BAA+B;AAC/B,MAAM,MAAM,kBAAkB,GAAG;IAC/B,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjC,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,CAAC;IAC5C,YAAY,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IACpE,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,OAAO,CAAC;IACvD,UAAU,CAAC,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,IAAI,CAAC;IACtD,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,CAAC;IAElC,KAAK,CAAC,EAAE,KAAK,CAAC;IAGd,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IAEtC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACpC,CAAC;AAqBF,gCAAgC;AAChC,qBAAa,aAAa;IACxB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC7B,MAAM,EAAE,iBAAiB,GAAG,eAAe,GAAG,IAAI,CAAQ;IAE1D,KAAK,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IACpC,cAAc,EAAE,cAAc,GAAG,IAAI,CAAQ;IAC7C,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAQ;IACjC,KAAK,EAAE,KAAK,CAAC;IACb,OAAO,EAAE,IAAI,CAAC;IACd,OAAO,EAAE,IAAI,CAAC;IACd,SAAS,EAAE,IAAI,CAAC;IAEhB,OAAO,EAAE,GAAG,CAAC;IAEb,WAAW,EAAE,MAAM,GAAG,KAAK,CAAiB;IAE5C,YAAY,EAAE,OAAO,CAAS;IAC9B,QAAQ,EAAE,OAAO,CAAS;IAC1B,iBAAiB,EAAE,GAAG,CAAQ;IAC9B,iBAAiB,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAQ;IACxD,iBAAiB,EAAE,CAAC,CAAC,aAAa,EAAE,aAAa,KAAK,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC1E,aAAa,EAAE,MAAM,CAAK;gBAOd,KAAK,EAAE,kBAAkB;IA8BrC,OAAO,IAAI,IAAI;IAKf,iCAAiC;IACjC,MAAM,IAAI,IAAI;IAId,kDAAkD;IAClD,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKpC,gDAAgD;IAChD,QAAQ,CAAC,KAAK,EAAE,yBAAyB,GAAG,IAAI;IAahD,kDAAkD;IAC5C,KAAK;IAuCX,yDAAyD;IACzD,IAAI;IAiBJ,8BAA8B;IAC9B,MAAM,IAAI,IAAI;IA0Bd,8EAA8E;IAC9E,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,QAAQ;IAK5C,wBAAwB;IACxB,cAAc,IAAI,IAAI;IAItB,oCAAoC;IACpC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAWvC,6CAA6C;IACvC,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAWlC,WAAW,IAAI,IAAI;IAcnB,WAAW,CAAC,OAAO,EAAE,GAAG,GAAG,IAAI;IAc/B,sBAAsB,IAAI,IAAI;IAc9B,qBAAqB,IAAI,IAAI;IAe7B,eAAe,IAAI,IAAI;IAUvB,YAAY,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;IAelD,iBAAiB,IAAI,IAAI;IAIzB,WAAW,IAAI,IAAI;IAMnB,yBAAyB,IAAI,IAAI;IAgCjC,kBAAkB,IAAI,cAAc;IAQpC,qBAAqB,IAAI,IAAI;IAoC7B,+BAA+B;IACzB,WAAW;IASjB,cAAc,IAAI,IAAI;IAsBtB,iBAAiB,IAAI;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC;IAsBpE,6BAA6B;IAC7B,eAAe,IAAI,IAAI;IAgBvB;;;OAGG;IACH,0BAA0B,IAAI,IAAI;IAMlC,iBAAiB;IAuBjB,eAAe;IAWf,mBAAmB;IAOnB,YAAY,CAAC,KAAK,EAAE,KAAK;IAMzB,aAAa,CAAC,KAAK,EAAE,KAAK;CAG3B"}