@lightningtv/renderer 2.16.1

package/dist/src/core/textures/SubTexture.js

@@ -0,0 +1,135 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { assertTruthy } from '../../utils.js';
+import { ImageTexture } from './ImageTexture.js';
+import { Texture, TextureType, } from './Texture.js';
+/**
+ * A Texture that is a sub-region of another Texture.
+ *
+ * @remarks
+ * The parent texture can be a Sprite Sheet/Texture Atlas and set using the
+ * {@link SubTextureProps.texture} prop. The sub-region relative to the parent
+ * texture is defined with the {@link SubTextureProps.x},
+ * {@link SubTextureProps.y}, {@link SubTextureProps.width}, and
+ * {@link SubTextureProps.height} pixel values.
+ */
+export class SubTexture extends Texture {
+    props;
+    parentTexture;
+    type = TextureType.subTexture;
+    constructor(txManager, props) {
+        super(txManager);
+        this.props = SubTexture.resolveDefaults(props || {});
+        assertTruthy(this.props.texture, 'SubTexture requires a parent texture');
+        assertTruthy(this.props.texture instanceof ImageTexture, 'SubTexture requires an ImageTexture parent');
+        // Resolve parent texture from cache or fallback to provided texture
+        this.parentTexture = txManager.resolveParentTexture(this.props.texture);
+        if (this.renderableOwners.size > 0) {
+            this.parentTexture.setRenderableOwner(this, true);
+        }
+        // If parent texture is already loaded / failed, trigger loaded event manually
+        // so that users get a consistent event experience.
+        // We do this in a microtask to allow listeners to be attached in the same
+        // synchronous task after calling loadTexture()
+        queueMicrotask(() => {
+            const parentTx = this.parentTexture;
+            if (parentTx.state === 'loaded') {
+                this.onParentTxLoaded(parentTx, parentTx.dimensions);
+            }
+            else if (parentTx.state === 'fetching') {
+                this.onParentTxFetching();
+            }
+            else if (parentTx.state === 'fetched') {
+                this.onParentTxFetched();
+            }
+            else if (parentTx.state === 'loading') {
+                this.onParentTxLoading();
+            }
+            else if (parentTx.state === 'failed') {
+                this.onParentTxFailed(parentTx, parentTx.error);
+            }
+            else if (parentTx.state === 'freed') {
+                this.onParentTxFreed();
+            }
+            parentTx.on('fetched', this.onParentTxFetched);
+            parentTx.on('loading', this.onParentTxLoading);
+            parentTx.on('fetching', this.onParentTxFetching);
+            parentTx.on('loaded', this.onParentTxLoaded);
+            parentTx.on('failed', this.onParentTxFailed);
+            parentTx.on('freed', this.onParentTxFreed);
+        });
+    }
+    onParentTxLoaded = () => {
+        // We ignore the parent's passed dimensions, and simply use the SubTexture's
+        // configured dimensions (because that's all that matters here)
+        this.forwardParentTxState('loaded', {
+            width: this.props.width,
+            height: this.props.height,
+        });
+    };
+    onParentTxFailed = (target, error) => {
+        this.forwardParentTxState('failed', error);
+    };
+    onParentTxFetched = () => {
+        this.forwardParentTxState('fetched', {
+            width: this.props.width,
+            height: this.props.height,
+        });
+    };
+    onParentTxFetching = () => {
+        this.forwardParentTxState('fetching');
+    };
+    onParentTxLoading = () => {
+        this.forwardParentTxState('loading');
+    };
+    onParentTxFreed = () => {
+        this.forwardParentTxState('freed');
+    };
+    forwardParentTxState(state, errorOrDimensions) {
+        this.setState(state, errorOrDimensions);
+    }
+    onChangeIsRenderable(isRenderable) {
+        // Propagate the renderable owner change to the parent texture
+        this.parentTexture.setRenderableOwner(this, isRenderable);
+    }
+    async getTextureSource() {
+        // Check if parent texture is loaded
+        return new Promise((resolve, reject) => {
+            this.setState('fetched');
+            resolve({
+                data: this.props,
+            });
+        });
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static makeCacheKey(props) {
+        return false;
+    }
+    static resolveDefaults(props) {
+        return {
+            texture: props.texture,
+            x: props.x || 0,
+            y: props.y || 0,
+            width: props.width || 0,
+            height: props.height || 0,
+        };
+    }
+    static z$__type__Props;
+}
+//# sourceMappingURL=SubTexture.js.map

package/dist/src/core/textures/SubTexture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SubTexture.js","sourceRoot":"","sources":["../../../../src/core/textures/SubTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EACL,OAAO,EACP,WAAW,GAKZ,MAAM,cAAc,CAAC;AAwCtB;;;;;;;;;GASG;AACH,MAAM,OAAO,UAAW,SAAQ,OAAO;IACrC,KAAK,CAA4B;IACjC,aAAa,CAAU;IAEP,IAAI,GAAgB,WAAW,CAAC,UAAU,CAAC;IAE3D,YAAY,SAA6B,EAAE,KAAsB;QAC/D,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;QAErD,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,sCAAsC,CAAC,CAAC;QACzE,YAAY,CACV,IAAI,CAAC,KAAK,CAAC,OAAO,YAAY,YAAY,EAC1C,4CAA4C,CAC7C,CAAC;QAEF,oEAAoE;QACpE,IAAI,CAAC,aAAa,GAAG,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAExE,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACnC,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACpD,CAAC;QAED,8EAA8E;QAC9E,mDAAmD;QACnD,0EAA0E;QAC1E,+CAA+C;QAC/C,cAAc,CAAC,GAAG,EAAE;YAClB,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC;YACpC,IAAI,QAAQ,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAChC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,UAAW,CAAC,CAAC;YACxD,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;gBACzC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC5B,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACvC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAM,CAAC,CAAC;YACnD,CAAC;iBAAM,IAAI,QAAQ,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBACtC,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,CAAC;YAED,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,QAAQ,CAAC,EAAE,CAAC,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjD,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB,GAA8B,GAAG,EAAE;QACzD,4EAA4E;QAC5E,+DAA+D;QAC/D,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE;YAClC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,gBAAgB,GAA8B,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QACtE,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEM,iBAAiB,GAAG,GAAG,EAAE;QAC/B,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE;YACnC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK;YACvB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC;IAEM,kBAAkB,GAAG,GAAG,EAAE;QAChC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;IACxC,CAAC,CAAC;IAEM,iBAAiB,GAAG,GAAG,EAAE;QAC/B,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IACvC,CAAC,CAAC;IAEM,eAAe,GAAG,GAAG,EAAE;QAC7B,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC,CAAC;IAEM,oBAAoB,CAC1B,KAAmB,EACnB,iBAAsC;QAEtC,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;IAC1C,CAAC;IAEQ,oBAAoB,CAAC,YAAqB;QACjD,8DAA8D;QAC9D,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC5D,CAAC;IAEQ,KAAK,CAAC,gBAAgB;QAC7B,oCAAoC;QACpC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC;gBACN,IAAI,EAAE,IAAI,CAAC,KAAK;aACjB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,6DAA6D;IAC7D,MAAM,CAAU,YAAY,CAAC,KAAsB;QACjD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAU,eAAe,CAC7B,KAAsB;QAEtB,OAAO;YACL,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;YACf,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;YACf,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,CAAC;YACvB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC;SAC1B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAkB;CACzC"}

package/dist/src/core/textures/Texture.d.ts

@@ -0,0 +1,211 @@
+import type { CoreTextureManager } from '../CoreTextureManager.js';
+import type { SubTextureProps } from './SubTexture.js';
+import type { Dimensions } from '../../common/CommonTypes.js';
+import { EventEmitter } from '../../common/EventEmitter.js';
+import type { CoreContextTexture } from '../renderers/CoreContextTexture.js';
+/**
+ * Event handler for when a Texture is freed
+ */
+export type TextureFreedEventHandler = (target: any) => void;
+/**
+ * Event handler for when a Texture is loading
+ */
+export type TextureLoadingEventHandler = (target: any) => void;
+/**
+ * Event handler for when a Texture is loaded
+ */
+export type TextureLoadedEventHandler = (target: any, dimensions: Readonly<Dimensions>) => void;
+/**
+ * Represents compressed texture data.
+ */
+interface CompressedData {
+    /**
+     * GLenum spcifying compression format
+     */
+    glInternalFormat: number;
+    /**
+     * All mipmap levels
+     */
+    mipmaps?: ArrayBuffer[];
+    /**
+     * Supported container types ('pvr' or 'ktx').
+     */
+    type: 'pvr' | 'ktx';
+    /**
+     * The width of the compressed texture in pixels. Defaults to 0.
+     *
+     * @default 0
+     */
+    width: number;
+    /**
+     * The height of the compressed texture in pixels.
+     **/
+    height: number;
+}
+/**
+ * Event handler for when a Texture fails to load
+ */
+export type TextureFailedEventHandler = (target: any, error: Error) => void;
+/**
+ * TextureData that is used to populate a CoreContextTexture
+ */
+export interface TextureData {
+    /**
+     * The texture data
+     */
+    data: ImageBitmap | ImageData | SubTextureProps | CompressedData | HTMLImageElement | Uint8Array | null;
+    /**
+     * Premultiply alpha when uploading texture data to the GPU
+     *
+     * @defaultValue `false`
+     */
+    premultiplyAlpha?: boolean | null;
+}
+export type TextureState = 'initial' | 'fetching' | 'fetched' | 'loading' | 'loaded' | 'failed' | 'freed';
+export declare enum TextureType {
+    'generic' = 0,
+    'color' = 1,
+    'image' = 2,
+    'noise' = 3,
+    'renderToTexture' = 4,
+    'subTexture' = 5
+}
+/**
+ * Represents a source of texture data for a CoreContextTexture.
+ *
+ * @remarks
+ * Texture sources are used to populate a CoreContextTexture when that texture
+ * is loaded. Texture data retrieved by the CoreContextTexture by the
+ * `getTextureData` method. It's the responsibility of the concerete `Texture`
+ * subclass to implement this method appropriately.
+ */
+export declare abstract class Texture extends EventEmitter {
+    protected txManager: CoreTextureManager;
+    /**
+     * The dimensions of the texture
+     *
+     * @remarks
+     * Until the texture data is loaded for the first time the value will be
+     * `null`.
+     */
+    private _dimensions;
+    private _error;
+    /**
+     * Texture states that are considered transitional and should be skipped during cleanup
+     */
+    static readonly TRANSITIONAL_TEXTURE_STATES: readonly TextureState[];
+    state: TextureState;
+    readonly renderableOwners: Set<unknown>;
+    readonly renderable: boolean;
+    type: TextureType;
+    preventCleanup: boolean;
+    ctxTexture: CoreContextTexture | undefined;
+    textureData: TextureData | null;
+    constructor(txManager: CoreTextureManager);
+    get dimensions(): Dimensions | null;
+    get error(): Error | null;
+    /**
+     * Add/remove an owner to/from the Texture based on its renderability.
+     *
+     * @remarks
+     * Any object can own a texture, be it a CoreNode or even the state object
+     * from a Text Renderer.
+     *
+     * When the reference to the texture that an owner object holds is replaced
+     * or cleared it must call this with `renderable=false` to release the owner
+     * association.
+     *
+     * @param owner
+     * @param renderable
+     */
+    setRenderableOwner(owner: unknown, renderable: boolean): void;
+    load(): void;
+    /**
+     * Event called when the Texture becomes renderable or unrenderable.
+     *
+     * @remarks
+     * Used by subclasses like SubTexture propogate then renderability of the
+     * Texture to other referenced Textures.
+     *
+     * @param isRenderable `true` if this Texture has renderable owners.
+     */
+    onChangeIsRenderable?(isRenderable: boolean): void;
+    /**
+     * Load the core context texture for this Texture.
+     * The ctxTexture is created by the renderer and lives on the GPU.
+     *
+     * @returns
+     */
+    loadCtxTexture(): CoreContextTexture;
+    /**
+     * Free the core context texture for this Texture.
+     *
+     * @remarks
+     * The ctxTexture is created by the renderer and lives on the GPU.
+     */
+    free(): void;
+    /**
+     * Destroy the texture.
+     *
+     * @remarks
+     * This method is called when the texture is no longer needed and should be
+     * cleaned up.
+     */
+    destroy(): void;
+    /**
+     * Free the source texture data for this Texture.
+     *
+     * @remarks
+     * The texture data is the source data that is used to populate the CoreContextTexture.
+     * e.g. ImageData that is downloaded from a URL.
+     */
+    freeTextureData(): void;
+    setState(state: TextureState, errorOrDimensions?: Error | Dimensions): void;
+    /**
+     * Get the texture data for this texture.
+     *
+     * @remarks
+     * This method is called by the CoreContextTexture when the texture is loaded.
+     * The texture data is then used to populate the CoreContextTexture.
+     *
+     * @returns
+     * The texture data for this texture.
+     */
+    getTextureData(): Promise<TextureData>;
+    /**
+     * Get the texture source for this texture.
+     *
+     * @remarks
+     * This method is called by the CoreContextTexture when the texture is loaded.
+     * The texture source is then used to populate the CoreContextTexture.
+     */
+    abstract getTextureSource(): Promise<TextureData>;
+    /**
+     * Make a cache key for this texture.
+     *
+     * @remarks
+     * Each concrete `Texture` subclass must implement this method to provide an
+     * appropriate cache key for the texture type including the texture's
+     * properties that uniquely identify a copy of the texture. If the texture
+     * type does not support caching, then this method should return `false`.
+     *
+     * @param props
+     * @returns
+     * A cache key for this texture or `false` if the texture type does not
+     * support caching.
+     */
+    static makeCacheKey(props: unknown): string | false;
+    /**
+     * Resolve the default values for the texture's properties.
+     *
+     * @remarks
+     * Each concrete `Texture` subclass must implement this method to provide
+     * default values for the texture's optional properties.
+     *
+     * @param props
+     * @returns
+     * The default values for the texture's properties.
+     */
+    static resolveDefaults(props: unknown): Record<string, unknown>;
+}
+export {};

package/dist/src/core/textures/Texture.js

@@ -0,0 +1,232 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast Cable Communications Management, LLC.
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { EventEmitter } from '../../common/EventEmitter.js';
+export var TextureType;
+(function (TextureType) {
+    TextureType[TextureType["generic"] = 0] = "generic";
+    TextureType[TextureType["color"] = 1] = "color";
+    TextureType[TextureType["image"] = 2] = "image";
+    TextureType[TextureType["noise"] = 3] = "noise";
+    TextureType[TextureType["renderToTexture"] = 4] = "renderToTexture";
+    TextureType[TextureType["subTexture"] = 5] = "subTexture";
+})(TextureType || (TextureType = {}));
+/**
+ * Represents a source of texture data for a CoreContextTexture.
+ *
+ * @remarks
+ * Texture sources are used to populate a CoreContextTexture when that texture
+ * is loaded. Texture data retrieved by the CoreContextTexture by the
+ * `getTextureData` method. It's the responsibility of the concerete `Texture`
+ * subclass to implement this method appropriately.
+ */
+export class Texture extends EventEmitter {
+    txManager;
+    /**
+     * The dimensions of the texture
+     *
+     * @remarks
+     * Until the texture data is loaded for the first time the value will be
+     * `null`.
+     */
+    _dimensions = null;
+    _error = null;
+    /**
+     * Texture states that are considered transitional and should be skipped during cleanup
+     */
+    static TRANSITIONAL_TEXTURE_STATES = ['fetching', 'fetched', 'loading'];
+    // aggregate state
+    state = 'initial';
+    renderableOwners = new Set();
+    renderable = false;
+    type = TextureType.generic;
+    preventCleanup = false;
+    ctxTexture;
+    textureData = null;
+    constructor(txManager) {
+        super();
+        this.txManager = txManager;
+    }
+    get dimensions() {
+        return this._dimensions;
+    }
+    get error() {
+        return this._error;
+    }
+    /**
+     * Add/remove an owner to/from the Texture based on its renderability.
+     *
+     * @remarks
+     * Any object can own a texture, be it a CoreNode or even the state object
+     * from a Text Renderer.
+     *
+     * When the reference to the texture that an owner object holds is replaced
+     * or cleared it must call this with `renderable=false` to release the owner
+     * association.
+     *
+     * @param owner
+     * @param renderable
+     */
+    setRenderableOwner(owner, renderable) {
+        const oldSize = this.renderableOwners.size;
+        if (renderable === true) {
+            if (this.renderableOwners.has(owner) === false) {
+                // Add the owner to the set
+                this.renderableOwners.add(owner);
+            }
+            const newSize = this.renderableOwners.size;
+            if (newSize > oldSize && newSize === 1) {
+                this.renderable = true;
+                this.onChangeIsRenderable?.(true);
+                this.load();
+            }
+        }
+        else {
+            this.renderableOwners.delete(owner);
+            const newSize = this.renderableOwners.size;
+            if (newSize < oldSize && newSize === 0) {
+                this.renderable = false;
+                this.onChangeIsRenderable?.(false);
+                this.txManager.orphanTexture(this);
+            }
+        }
+    }
+    load() {
+        this.txManager.loadTexture(this);
+    }
+    /**
+     * Load the core context texture for this Texture.
+     * The ctxTexture is created by the renderer and lives on the GPU.
+     *
+     * @returns
+     */
+    loadCtxTexture() {
+        if (this.ctxTexture === undefined) {
+            this.ctxTexture = this.txManager.renderer.createCtxTexture(this);
+        }
+        return this.ctxTexture;
+    }
+    /**
+     * Free the core context texture for this Texture.
+     *
+     * @remarks
+     * The ctxTexture is created by the renderer and lives on the GPU.
+     */
+    free() {
+        this.ctxTexture?.free();
+    }
+    /**
+     * Destroy the texture.
+     *
+     * @remarks
+     * This method is called when the texture is no longer needed and should be
+     * cleaned up.
+     */
+    destroy() {
+        // Only free GPU resources if we're in a state where they exist
+        if (this.state === 'loaded') {
+            this.free();
+        }
+        // Always free texture data regardless of state
+        this.freeTextureData();
+    }
+    /**
+     * Free the source texture data for this Texture.
+     *
+     * @remarks
+     * The texture data is the source data that is used to populate the CoreContextTexture.
+     * e.g. ImageData that is downloaded from a URL.
+     */
+    freeTextureData() {
+        this.textureData = null;
+    }
+    setState(state, errorOrDimensions) {
+        if (this.state === state) {
+            return;
+        }
+        let payload = null;
+        if (state === 'loaded') {
+            if (errorOrDimensions !== undefined &&
+                'width' in errorOrDimensions === true &&
+                'height' in errorOrDimensions === true &&
+                errorOrDimensions.width !== undefined &&
+                errorOrDimensions.height !== undefined) {
+                this._dimensions = errorOrDimensions;
+            }
+            payload = this._dimensions;
+        }
+        else if (state === 'failed') {
+            this._error = errorOrDimensions;
+            payload = this._error;
+        }
+        // emit the new state
+        this.state = state;
+        this.emit(state, payload);
+    }
+    /**
+     * Get the texture data for this texture.
+     *
+     * @remarks
+     * This method is called by the CoreContextTexture when the texture is loaded.
+     * The texture data is then used to populate the CoreContextTexture.
+     *
+     * @returns
+     * The texture data for this texture.
+     */
+    async getTextureData() {
+        if (this.textureData === null) {
+            this.textureData = await this.getTextureSource();
+        }
+        return this.textureData;
+    }
+    /**
+     * Make a cache key for this texture.
+     *
+     * @remarks
+     * Each concrete `Texture` subclass must implement this method to provide an
+     * appropriate cache key for the texture type including the texture's
+     * properties that uniquely identify a copy of the texture. If the texture
+     * type does not support caching, then this method should return `false`.
+     *
+     * @param props
+     * @returns
+     * A cache key for this texture or `false` if the texture type does not
+     * support caching.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static makeCacheKey(props) {
+        return false;
+    }
+    /**
+     * Resolve the default values for the texture's properties.
+     *
+     * @remarks
+     * Each concrete `Texture` subclass must implement this method to provide
+     * default values for the texture's optional properties.
+     *
+     * @param props
+     * @returns
+     * The default values for the texture's properties.
+     */
+    static resolveDefaults(
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    props) {
+        return {};
+    }
+}
+//# sourceMappingURL=Texture.js.map

package/dist/src/core/textures/Texture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Texture.js","sourceRoot":"","sources":["../../../../src/core/textures/Texture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAKH,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AA0F5D,MAAM,CAAN,IAAY,WAOX;AAPD,WAAY,WAAW;IACrB,mDAAa,CAAA;IACb,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,+CAAW,CAAA;IACX,mEAAqB,CAAA;IACrB,yDAAgB,CAAA;AAClB,CAAC,EAPW,WAAW,KAAX,WAAW,QAOtB;AAED;;;;;;;;GAQG;AACH,MAAM,OAAgB,OAAQ,SAAQ,YAAY;IAgC1B;IA/BtB;;;;;;OAMG;IACK,WAAW,GAAsB,IAAI,CAAC;IACtC,MAAM,GAAiB,IAAI,CAAC;IAEpC;;OAEG;IACI,MAAM,CAAU,2BAA2B,GAChD,CAAC,UAAU,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAErC,kBAAkB;IACX,KAAK,GAAiB,SAAS,CAAC;IAE9B,gBAAgB,GAAG,IAAI,GAAG,EAAW,CAAC;IAEtC,UAAU,GAAY,KAAK,CAAC;IAE9B,IAAI,GAAgB,WAAW,CAAC,OAAO,CAAC;IAExC,cAAc,GAAG,KAAK,CAAC;IAEvB,UAAU,CAAiC;IAE3C,WAAW,GAAuB,IAAI,CAAC;IAE9C,YAAsB,SAA6B;QACjD,KAAK,EAAE,CAAC;QADY,cAAS,GAAT,SAAS,CAAoB;IAEnD,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,KAAc,EAAE,UAAmB;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;QAE3C,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;gBAC/C,2BAA2B;gBAC3B,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;YAED,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAC3C,IAAI,OAAO,GAAG,OAAO,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAsB,GAAG,IAAI,CAAC;gBACpC,IAAI,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC;gBAClC,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC;YAC3C,IAAI,OAAO,GAAG,OAAO,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;gBACtC,IAAI,CAAC,UAAsB,GAAG,KAAK,CAAC;gBACrC,IAAI,CAAC,oBAAoB,EAAE,CAAC,KAAK,CAAC,CAAC;gBACnC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YACrC,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI;QACF,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAaD;;;;;OAKG;IACH,cAAc;QACZ,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;YAClC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACnE,CAAC;QAED,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACF,IAAI,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;;OAMG;IACH,OAAO;QACL,+DAA+D;QAC/D,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,CAAC;QAED,+CAA+C;QAC/C,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,eAAe;QACb,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAEM,QAAQ,CACb,KAAmB,EACnB,iBAAsC;QAEtC,IAAI,IAAI,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;YACzB,OAAO;QACT,CAAC;QAED,IAAI,OAAO,GAA8B,IAAI,CAAC;QAC9C,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvB,IACE,iBAAiB,KAAK,SAAS;gBAC/B,OAAO,IAAI,iBAAiB,KAAK,IAAI;gBACrC,QAAQ,IAAI,iBAAiB,KAAK,IAAI;gBACtC,iBAAiB,CAAC,KAAK,KAAK,SAAS;gBACrC,iBAAiB,CAAC,MAAM,KAAK,SAAS,EACtC,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,iBAAiB,CAAC;YACvC,CAAC;YAED,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7B,CAAC;aAAM,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,GAAG,iBAA0B,CAAC;YACzC,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;QACxB,CAAC;QAED,qBAAqB;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,WAAW,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACnD,CAAC;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAWD;;;;;;;;;;;;;OAaG;IACH,6DAA6D;IAC7D,MAAM,CAAC,YAAY,CAAC,KAAc;QAChC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,CAAC,eAAe;IACpB,6DAA6D;IAC7D,KAAc;QAEd,OAAO,EAAE,CAAC;IACZ,CAAC"}

package/dist/src/core/utils.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Core Utility Functions
+ *
+ * @module
+ */
+export declare const EPSILON = 0.000001;
+export declare let ARRAY_TYPE: ArrayConstructor | Float32ArrayConstructor;
+export declare const RANDOM: () => number;
+export declare const ANGLE_ORDER = "zyx";
+export declare const setMatrixArrayType: (type: Float32ArrayConstructor | ArrayConstructor) => void;
+export declare const toRadian: (a: number) => number;
+export declare const equals: (a: number, b: number) => boolean;
+export declare const rand: (min: number, max: number) => number;
+export declare const isPowerOfTwo: (value: number) => boolean | 0;
+export declare const getTimingFunction: (str: string) => ((time: number) => number | undefined);
+/**
+ * Convert bytes to string of megabytes with 2 decimal points
+ *
+ * @param bytes
+ * @returns
+ */
+export declare function bytesToMb(bytes: number): string;