@lightningtv/renderer 3.0.0-beta1

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

@@ -0,0 +1,124 @@
+import type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, TextureType, type TextureData } from './Texture.js';
+/**
+ * Properties of the {@link ImageTexture}
+ */
+export interface ImageTextureProps {
+    /**
+     * Source URL or ImageData for the image to be used as a texture.
+     *
+     * @remarks
+     * The ImageData type is currently only supported internally. End users should
+     * only set this property to a URL string.
+     *
+     * @default ''
+     */
+    src?: string | ImageData | (() => ImageData | null);
+    /**
+     * Whether to premultiply the alpha channel into the color channels of the
+     * image.
+     *
+     * @remarks
+     * Generally this should be set to `true` (the default). However, if the
+     * texture's associated Shader expects straight (non-premultiplied) colors,
+     * this should be set to `false`.
+     *
+     * @default true
+     */
+    premultiplyAlpha?: boolean | null;
+    /**
+     * `ImageData` textures are not cached unless a `key` is provided
+     */
+    key?: string | null;
+    /**
+     * Width of the image to be used as a texture. If not provided, the image's
+     * natural width will be used.
+     */
+    width?: number | null;
+    /**
+     * Height of the image to be used as a texture. If not provided, the image's
+     * natural height will be used.
+     */
+    height?: number | null;
+    /**
+     * Type, indicate an image type for overriding type detection
+     *
+     * @default null
+     */
+    type?: 'regular' | 'compressed' | 'svg' | null;
+    /**
+     * The width of the rectangle from which the ImageBitmap will be extracted. This value
+     * can be negative. Only works when createImageBitmap is supported on the browser.
+     *
+     * @default null
+     */
+    sw?: number | null;
+    /**
+     * The height of the rectangle from which the ImageBitmap will be extracted. This value
+     * can be negative. Only works when createImageBitmap is supported on the browser.
+     *
+     * @default null
+     */
+    sh?: number | null;
+    /**
+     * The y coordinate of the reference point of the rectangle from which the ImageBitmap
+     * will be extracted. Only used when `sw` and `sh` are provided. And only works when
+     * createImageBitmap is available.
+     *
+     * @default null
+     */
+    sx?: number | null;
+    /**
+     * The x coordinate of the reference point of the rectangle from which the
+     * ImageBitmap will be extracted. Only used when source `sw` width and `sh` height
+     * are provided. Only works when createImageBitmap is supported on the browser.
+     *
+     * @default null
+     */
+    sy?: number | null;
+}
+/**
+ * Texture consisting of an image loaded from a URL
+ *
+ * @remarks
+ * The ImageTexture's {@link ImageTextureProps.src} prop defines the image URL
+ * to be downloaded.
+ *
+ * By default, the texture's alpha values will be premultiplied into its color
+ * values which is generally the desired setting before they are sent to the
+ * texture's associated {@link Shader}. However, in special cases you may want
+ * the Shader to receive straight (non-premultiplied) values. In that case you
+ * can disable the default behavior by setting the
+ * {@link ImageTextureProps.premultiplyAlpha} prop to `false`.
+ */
+export declare class ImageTexture extends Texture {
+    props: Required<ImageTextureProps>;
+    type: TextureType;
+    constructor(txManager: CoreTextureManager, props: ImageTextureProps);
+    hasAlphaChannel(mimeType: string): boolean;
+    loadImageFallback(src: string, hasAlpha: boolean): Promise<{
+        data: HTMLImageElement;
+        premultiplyAlpha: boolean;
+    }>;
+    createImageBitmap(blob: Blob, premultiplyAlpha: boolean | null, sx: number | null, sy: number | null, sw: number | null, sh: number | null): Promise<{
+        data: ImageBitmap | HTMLImageElement;
+        premultiplyAlpha: boolean;
+    }>;
+    loadImage(src: string): Promise<TextureData>;
+    getTextureSource(): Promise<TextureData>;
+    determineImageTypeAndLoadImage(): Promise<TextureData> | {
+        data: null;
+        premultiplyAlpha?: undefined;
+    } | {
+        data: ImageData | null;
+        premultiplyAlpha: boolean | null;
+    };
+    /**
+     * Generates a cache key for the ImageTexture based on the provided props.
+     * @param props - The props used to generate the cache key.
+     * @returns The cache key as a string, or `false` if the key cannot be generated.
+     */
+    static makeCacheKey(props: ImageTextureProps): string | false;
+    static resolveDefaults(props: ImageTextureProps): Required<ImageTextureProps>;
+    static z$__type__Props: ImageTextureProps;
+}

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

@@ -0,0 +1,220 @@
+/*
+ * 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 { Texture, TextureType } from './Texture.js';
+import { isCompressedTextureContainer, loadCompressedTexture, } from '../lib/textureCompression.js';
+import { convertUrlToAbsolute, isBase64Image } from '../lib/utils.js';
+import { isSvgImage, loadSvg } from '../lib/textureSvg.js';
+import { fetchJson } from '../text-rendering/font-face-types/utils.js';
+/**
+ * Texture consisting of an image loaded from a URL
+ *
+ * @remarks
+ * The ImageTexture's {@link ImageTextureProps.src} prop defines the image URL
+ * to be downloaded.
+ *
+ * By default, the texture's alpha values will be premultiplied into its color
+ * values which is generally the desired setting before they are sent to the
+ * texture's associated {@link Shader}. However, in special cases you may want
+ * the Shader to receive straight (non-premultiplied) values. In that case you
+ * can disable the default behavior by setting the
+ * {@link ImageTextureProps.premultiplyAlpha} prop to `false`.
+ */
+export class ImageTexture extends Texture {
+    props;
+    type = TextureType.image;
+    constructor(txManager, props) {
+        super(txManager);
+        this.props = ImageTexture.resolveDefaults(props);
+    }
+    hasAlphaChannel(mimeType) {
+        return mimeType.indexOf('image/png') !== -1;
+    }
+    async loadImageFallback(src, hasAlpha) {
+        const img = new Image();
+        if (isBase64Image(src) === false) {
+            img.crossOrigin = 'anonymous';
+        }
+        return new Promise((resolve) => {
+            img.onload = () => {
+                resolve({ data: img, premultiplyAlpha: hasAlpha });
+            };
+            img.onerror = () => {
+                console.warn('Image loading failed, returning fallback object.');
+                resolve({ data: img, premultiplyAlpha: hasAlpha });
+            };
+            img.src = src;
+        });
+    }
+    async createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh) {
+        const hasAlphaChannel = premultiplyAlpha ?? blob.type.includes('image/png');
+        const imageBitmapSupported = this.txManager.imageBitmapSupported;
+        if (imageBitmapSupported.full === true && sw !== null && sh !== null) {
+            // createImageBitmap with crop
+            const bitmap = await createImageBitmap(blob, sx || 0, sy || 0, sw, sh, {
+                premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
+                colorSpaceConversion: 'none',
+                imageOrientation: 'none',
+            });
+            return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
+        }
+        else if (imageBitmapSupported.basic === true) {
+            // basic createImageBitmap without options or crop
+            // this is supported for Chrome v50 to v52/54 that doesn't support options
+            return {
+                data: await createImageBitmap(blob),
+                premultiplyAlpha: hasAlphaChannel,
+            };
+        }
+        // default createImageBitmap without crop but with options
+        const bitmap = await createImageBitmap(blob, {
+            premultiplyAlpha: hasAlphaChannel ? 'premultiply' : 'none',
+            colorSpaceConversion: 'none',
+            imageOrientation: 'none',
+        });
+        return { data: bitmap, premultiplyAlpha: hasAlphaChannel };
+    }
+    async loadImage(src) {
+        const { premultiplyAlpha, sx, sy, sw, sh } = this.props;
+        if (this.txManager.hasCreateImageBitmap === true) {
+            if (isBase64Image(src) === false &&
+                this.txManager.hasWorker === true &&
+                this.txManager.imageWorkerManager !== null) {
+                return this.txManager.imageWorkerManager.getImage(src, premultiplyAlpha, sx, sy, sw, sh);
+            }
+            const blob = await fetchJson(src, 'blob').then((response) => response);
+            return this.createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh);
+        }
+        return this.loadImageFallback(src, premultiplyAlpha ?? true);
+    }
+    async getTextureSource() {
+        let resp;
+        try {
+            resp = await this.determineImageTypeAndLoadImage();
+        }
+        catch (e) {
+            this.setState('failed', e);
+            return {
+                data: null,
+            };
+        }
+        if (resp.data === null) {
+            this.setState('failed', Error('ImageTexture: No image data'));
+            return {
+                data: null,
+            };
+        }
+        let width, height;
+        // check if resp.data is typeof Uint8ClampedArray else
+        // use resp.data.width and resp.data.height
+        if (resp.data instanceof Uint8Array) {
+            width = this.props.width ?? 0;
+            height = this.props.height ?? 0;
+        }
+        else {
+            width = resp.data?.width ?? (this.props.width || 0);
+            height = resp.data?.height ?? (this.props.height || 0);
+        }
+        // we're loaded!
+        this.setState('fetched', {
+            width,
+            height,
+        });
+        return {
+            data: resp.data,
+            premultiplyAlpha: this.props.premultiplyAlpha ?? true,
+        };
+    }
+    determineImageTypeAndLoadImage() {
+        const { src, premultiplyAlpha, type } = this.props;
+        if (src === null) {
+            return {
+                data: null,
+            };
+        }
+        if (typeof src !== 'string') {
+            if (src instanceof ImageData) {
+                return {
+                    data: src,
+                    premultiplyAlpha,
+                };
+            }
+            return {
+                data: src(),
+                premultiplyAlpha,
+            };
+        }
+        const absoluteSrc = convertUrlToAbsolute(src);
+        if (type === 'regular') {
+            return this.loadImage(absoluteSrc);
+        }
+        if (type === 'svg') {
+            return loadSvg(absoluteSrc, this.props.width, this.props.height, this.props.sx, this.props.sy, this.props.sw, this.props.sh);
+        }
+        if (isSvgImage(src) === true) {
+            return loadSvg(absoluteSrc, this.props.width, this.props.height, this.props.sx, this.props.sy, this.props.sw, this.props.sh);
+        }
+        if (type === 'compressed') {
+            return loadCompressedTexture(absoluteSrc);
+        }
+        if (isCompressedTextureContainer(src) === true) {
+            return loadCompressedTexture(absoluteSrc);
+        }
+        // default
+        return this.loadImage(absoluteSrc);
+    }
+    /**
+     * Generates a cache key for the ImageTexture based on the provided props.
+     * @param props - The props used to generate the cache key.
+     * @returns The cache key as a string, or `false` if the key cannot be generated.
+     */
+    static makeCacheKey(props) {
+        const resolvedProps = ImageTexture.resolveDefaults(props);
+        // Only cache key-able textures; prioritise key
+        const key = resolvedProps.key || resolvedProps.src;
+        if (typeof key !== 'string') {
+            return false;
+        }
+        // if we have source dimensions, cache the texture separately
+        let dimensionProps = '';
+        if (resolvedProps.sh !== null && resolvedProps.sw !== null) {
+            dimensionProps += ',';
+            dimensionProps += resolvedProps.sx ?? '';
+            dimensionProps += resolvedProps.sy ?? '';
+            dimensionProps += resolvedProps.sw || '';
+            dimensionProps += resolvedProps.sh || '';
+        }
+        return `ImageTexture,${key},${resolvedProps.premultiplyAlpha ?? 'true'}${dimensionProps}`;
+    }
+    static resolveDefaults(props) {
+        return {
+            src: props.src ?? '',
+            premultiplyAlpha: props.premultiplyAlpha ?? true, // null,
+            key: props.key ?? null,
+            type: props.type ?? null,
+            width: props.width ?? null,
+            height: props.height ?? null,
+            sx: props.sx ?? null,
+            sy: props.sy ?? null,
+            sw: props.sw ?? null,
+            sh: props.sh ?? null,
+        };
+    }
+    static z$__type__Props;
+}
+//# sourceMappingURL=ImageTexture.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ImageTexture.js","sourceRoot":"","sources":["../../../../src/core/textures/ImageTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAoB,MAAM,cAAc,CAAC;AACtE,OAAO,EACL,4BAA4B,EAC5B,qBAAqB,GACtB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,EAAE,SAAS,EAAE,MAAM,4CAA4C,CAAC;AAgFvE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,YAAa,SAAQ,OAAO;IAChC,KAAK,CAA8B;IAE1B,IAAI,GAAgB,WAAW,CAAC,KAAK,CAAC;IAEtD,YAAY,SAA6B,EAAE,KAAwB;QACjE,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,eAAe,CAAC,QAAgB;QAC9B,OAAO,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,GAAW,EAAE,QAAiB;QACpD,MAAM,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;QAExB,IAAI,aAAa,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;YACjC,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QAChC,CAAC;QAED,OAAO,IAAI,OAAO,CAChB,CAAC,OAAO,EAAE,EAAE;YACV,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE;gBAChB,OAAO,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrD,CAAC,CAAC;YAEF,GAAG,CAAC,OAAO,GAAG,GAAG,EAAE;gBACjB,OAAO,CAAC,IAAI,CAAC,kDAAkD,CAAC,CAAC;gBACjE,OAAO,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,gBAAgB,EAAE,QAAQ,EAAE,CAAC,CAAC;YACrD,CAAC,CAAC;YAEF,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,IAAU,EACV,gBAAgC,EAChC,EAAiB,EACjB,EAAiB,EACjB,EAAiB,EACjB,EAAiB;QAKjB,MAAM,eAAe,GAAG,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC5E,MAAM,oBAAoB,GAAG,IAAI,CAAC,SAAS,CAAC,oBAAoB,CAAC;QAEjE,IAAI,oBAAoB,CAAC,IAAI,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;YACrE,8BAA8B;YAC9B,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;gBACrE,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;gBAC1D,oBAAoB,EAAE,MAAM;gBAC5B,gBAAgB,EAAE,MAAM;aACzB,CAAC,CAAC;YACH,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC;QAC7D,CAAC;aAAM,IAAI,oBAAoB,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;YAC/C,kDAAkD;YAClD,0EAA0E;YAC1E,OAAO;gBACL,IAAI,EAAE,MAAM,iBAAiB,CAAC,IAAI,CAAC;gBACnC,gBAAgB,EAAE,eAAe;aAClC,CAAC;QACJ,CAAC;QAED,0DAA0D;QAC1D,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,IAAI,EAAE;YAC3C,gBAAgB,EAAE,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM;YAC1D,oBAAoB,EAAE,MAAM;YAC5B,gBAAgB,EAAE,MAAM;SACzB,CAAC,CAAC;QACH,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW;QACzB,MAAM,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAExD,IAAI,IAAI,CAAC,SAAS,CAAC,oBAAoB,KAAK,IAAI,EAAE,CAAC;YACjD,IACE,aAAa,CAAC,GAAG,CAAC,KAAK,KAAK;gBAC5B,IAAI,CAAC,SAAS,CAAC,SAAS,KAAK,IAAI;gBACjC,IAAI,CAAC,SAAS,CAAC,kBAAkB,KAAK,IAAI,EAC1C,CAAC;gBACD,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,QAAQ,CAC/C,GAAG,EACH,gBAAgB,EAChB,EAAE,EACF,EAAE,EACF,EAAE,EACF,EAAE,CACH,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,IAAI,CAC5C,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAgB,CAC/B,CAAC;YACF,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,gBAAgB,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAEQ,KAAK,CAAC,gBAAgB;QAC7B,IAAI,IAAI,CAAC;QACT,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC;QACrD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAU,CAAC,CAAC;YACpC,OAAO;gBACL,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;YAC9D,OAAO;gBACL,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,EAAE,MAAM,CAAC;QAClB,sDAAsD;QACtD,2CAA2C;QAC3C,IAAI,IAAI,CAAC,IAAI,YAAY,UAAU,EAAE,CAAC;YACpC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC;YAC9B,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;YACpD,MAAM,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;QACzD,CAAC;QAED,gBAAgB;QAChB,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE;YACvB,KAAK;YACL,MAAM;SACP,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI;SACtD,CAAC;IACJ,CAAC;IAED,8BAA8B;QAC5B,MAAM,EAAE,GAAG,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACnD,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO;gBACL,IAAI,EAAE,IAAI;aACX,CAAC;QACJ,CAAC;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,IAAI,GAAG,YAAY,SAAS,EAAE,CAAC;gBAC7B,OAAO;oBACL,IAAI,EAAE,GAAG;oBACT,gBAAgB;iBACjB,CAAC;YACJ,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,GAAG,EAAE;gBACX,gBAAgB;aACjB,CAAC;QACJ,CAAC;QAED,MAAM,WAAW,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;YACnB,OAAO,OAAO,CACZ,WAAW,EACX,IAAI,CAAC,KAAK,CAAC,KAAK,EAChB,IAAI,CAAC,KAAK,CAAC,MAAM,EACjB,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,CACd,CAAC;QACJ,CAAC;QAED,IAAI,UAAU,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YAC7B,OAAO,OAAO,CACZ,WAAW,EACX,IAAI,CAAC,KAAK,CAAC,KAAK,EAChB,IAAI,CAAC,KAAK,CAAC,MAAM,EACjB,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,EACb,IAAI,CAAC,KAAK,CAAC,EAAE,CACd,CAAC;QACJ,CAAC;QAED,IAAI,IAAI,KAAK,YAAY,EAAE,CAAC;YAC1B,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,4BAA4B,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,CAAC;YAC/C,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;QAC5C,CAAC;QAED,UAAU;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACrC,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAU,YAAY,CAAC,KAAwB;QACnD,MAAM,aAAa,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC1D,+CAA+C;QAC/C,MAAM,GAAG,GAAG,aAAa,CAAC,GAAG,IAAI,aAAa,CAAC,GAAG,CAAC;QACnD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,6DAA6D;QAC7D,IAAI,cAAc,GAAG,EAAE,CAAC;QACxB,IAAI,aAAa,CAAC,EAAE,KAAK,IAAI,IAAI,aAAa,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;YAC3D,cAAc,IAAI,GAAG,CAAC;YACtB,cAAc,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;YACzC,cAAc,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;YACzC,cAAc,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;YACzC,cAAc,IAAI,aAAa,CAAC,EAAE,IAAI,EAAE,CAAC;QAC3C,CAAC;QAED,OAAO,gBAAgB,GAAG,IACxB,aAAa,CAAC,gBAAgB,IAAI,MACpC,GAAG,cAAc,EAAE,CAAC;IACtB,CAAC;IAED,MAAM,CAAU,eAAe,CAC7B,KAAwB;QAExB,OAAO;YACL,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,EAAE;YACpB,gBAAgB,EAAE,KAAK,CAAC,gBAAgB,IAAI,IAAI,EAAE,QAAQ;YAC1D,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,IAAI;YACtB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,IAAI;YAC1B,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,IAAI;YAC5B,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI;YACpB,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI;YACpB,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI;YACpB,EAAE,EAAE,KAAK,CAAC,EAAE,IAAI,IAAI;SACrB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAoB;CAC3C"}

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

@@ -0,0 +1,43 @@
+import type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, TextureType, type TextureData } from './Texture.js';
+/**
+ * Properties of the {@link NoiseTexture}
+ */
+export interface NoiseTextureProps {
+    /**
+     * Width of texture
+     *
+     * @default 128
+     */
+    width?: number;
+    /**
+     * Height of texture
+     *
+     * @default 128
+     */
+    height?: number;
+    /**
+     * A number value that can be varied to force new textures to be generated
+     *
+     * @default 0
+     */
+    cacheId?: number;
+}
+/**
+ * Texture consisting of a random grid of greyscale pixels
+ *
+ * @remarks
+ * The width and height of the NoiseTexture are defined by it's
+ * {@link NoiseTextureProps.width} and {@link NoiseTextureProps.height}
+ * properties. The {@link NoiseTextureProps.cacheId} prop can be varied in order
+ * to bypass cache and get newly randomized texture data.
+ */
+export declare class NoiseTexture extends Texture {
+    props: Required<NoiseTextureProps>;
+    type: TextureType;
+    constructor(txManager: CoreTextureManager, props: NoiseTextureProps);
+    getTextureSource(): Promise<TextureData>;
+    static makeCacheKey(props: NoiseTextureProps): string | false;
+    static resolveDefaults(props: NoiseTextureProps): Required<NoiseTextureProps>;
+    static z$__type__Props: NoiseTextureProps;
+}

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

@@ -0,0 +1,68 @@
+/*
+ * 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 { Texture, TextureType } from './Texture.js';
+/**
+ * Texture consisting of a random grid of greyscale pixels
+ *
+ * @remarks
+ * The width and height of the NoiseTexture are defined by it's
+ * {@link NoiseTextureProps.width} and {@link NoiseTextureProps.height}
+ * properties. The {@link NoiseTextureProps.cacheId} prop can be varied in order
+ * to bypass cache and get newly randomized texture data.
+ */
+export class NoiseTexture extends Texture {
+    props;
+    type = TextureType.noise;
+    constructor(txManager, props) {
+        super(txManager);
+        this.props = NoiseTexture.resolveDefaults(props);
+    }
+    async getTextureSource() {
+        const { width, height } = this.props;
+        const size = width * height * 4;
+        const pixelData8 = new Uint8ClampedArray(size);
+        for (let i = 0; i < size; i += 4) {
+            const v = Math.floor(Math.random() * 256);
+            pixelData8[i] = v;
+            pixelData8[i + 1] = v;
+            pixelData8[i + 2] = v;
+            pixelData8[i + 3] = 255;
+        }
+        this.setState('fetched');
+        return {
+            data: new ImageData(pixelData8, width, height),
+        };
+    }
+    static makeCacheKey(props) {
+        if (props.cacheId === undefined) {
+            return false;
+        }
+        const resolvedProps = NoiseTexture.resolveDefaults(props);
+        return `NoiseTexture,${resolvedProps.width},${resolvedProps.height},${resolvedProps.cacheId}`;
+    }
+    static resolveDefaults(props) {
+        return {
+            width: props.width ?? 128,
+            height: props.height ?? 128,
+            cacheId: props.cacheId ?? 0,
+        };
+    }
+    static z$__type__Props;
+}
+//# sourceMappingURL=NoiseTexture.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"NoiseTexture.js","sourceRoot":"","sources":["../../../../src/core/textures/NoiseTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAoB,MAAM,cAAc,CAAC;AA0BtE;;;;;;;;GAQG;AACH,MAAM,OAAO,YAAa,SAAQ,OAAO;IACvC,KAAK,CAA8B;IAEnB,IAAI,GAAgB,WAAW,CAAC,KAAK,CAAC;IAEtD,YAAY,SAA6B,EAAE,KAAwB;QACjE,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAEQ,KAAK,CAAC,gBAAgB;QAC7B,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACrC,MAAM,IAAI,GAAG,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACjC,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;YAC1C,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAClB,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACtB,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YACtB,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEzB,OAAO;YACL,IAAI,EAAE,IAAI,SAAS,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,CAAC;SAC/C,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,YAAY,CAAC,KAAwB;QACnD,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,aAAa,GAAG,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC1D,OAAO,gBAAgB,aAAa,CAAC,KAAK,IAAI,aAAa,CAAC,MAAM,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;IAChG,CAAC;IAED,MAAM,CAAU,eAAe,CAC7B,KAAwB;QAExB,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,GAAG;YACzB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,GAAG;YAC3B,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,CAAC;SAC5B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAoB;CAC3C"}

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

@@ -0,0 +1,29 @@
+import type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, TextureType, type TextureData } from './Texture.js';
+/**
+ * Properties of the {@link RenderTexture}
+ */
+export interface RenderTextureProps {
+    /**
+     * WebGL Texture width
+     * @default 256
+     */
+    width?: number;
+    /**
+     * WebGL Texture height
+     * @default 256
+     */
+    height?: number;
+}
+export declare class RenderTexture extends Texture {
+    props: Required<RenderTextureProps>;
+    type: TextureType;
+    constructor(txManager: CoreTextureManager, props?: RenderTextureProps);
+    get width(): number;
+    set width(value: number);
+    get height(): number;
+    set height(value: number);
+    getTextureSource(): Promise<TextureData>;
+    static resolveDefaults(props: RenderTextureProps): Required<RenderTextureProps>;
+    static z$__type__Props: RenderTextureProps;
+}

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

@@ -0,0 +1,54 @@
+/*
+ * 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 { Texture, TextureType } from './Texture.js';
+export class RenderTexture extends Texture {
+    props;
+    type = TextureType.renderToTexture;
+    constructor(txManager, props) {
+        super(txManager);
+        this.props = RenderTexture.resolveDefaults(props || {});
+    }
+    get width() {
+        return this.props.width;
+    }
+    set width(value) {
+        this.props.width = value;
+    }
+    get height() {
+        return this.props.height;
+    }
+    set height(value) {
+        this.props.height = value;
+    }
+    async getTextureSource() {
+        this.setState('fetched');
+        return {
+            data: null,
+            premultiplyAlpha: null,
+        };
+    }
+    static resolveDefaults(props) {
+        return {
+            width: props.width || 256,
+            height: props.height || 256,
+        };
+    }
+    static z$__type__Props;
+}
+//# sourceMappingURL=RenderTexture.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RenderTexture.js","sourceRoot":"","sources":["../../../../src/core/textures/RenderTexture.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAGH,OAAO,EAAE,OAAO,EAAE,WAAW,EAAoB,MAAM,cAAc,CAAC;AAmBtE,MAAM,OAAO,aAAc,SAAQ,OAAO;IACxC,KAAK,CAA+B;IAEpB,IAAI,GAAgB,WAAW,CAAC,eAAe,CAAC;IAEhE,YAAY,SAA6B,EAAE,KAA0B;QACnE,KAAK,CAAC,SAAS,CAAC,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;IAC1B,CAAC;IAED,IAAI,KAAK,CAAC,KAAa;QACrB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,IAAI,MAAM,CAAC,KAAa;QACtB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC;IAC5B,CAAC;IAEQ,KAAK,CAAC,gBAAgB;QAC7B,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEzB,OAAO;YACL,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAU,eAAe,CAC7B,KAAyB;QAEzB,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,KAAK,IAAI,GAAG;YACzB,MAAM,EAAE,KAAK,CAAC,MAAM,IAAI,GAAG;SAC5B,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe,CAAqB;CAC5C"}

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

@@ -0,0 +1,63 @@
+import type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, TextureType, type TextureData } from './Texture.js';
+/**
+ * Properties of the {@link SubTexture}
+ */
+export interface SubTextureProps {
+    /**
+     * The texture that this sub-texture is a sub-region of.
+     */
+    texture: Texture;
+    /**
+     * The x pixel position of the top-left of the sub-texture within the parent
+     * texture.
+     *
+     * @default 0
+     */
+    x?: number;
+    /**
+     * The y pixel position of the top-left sub-texture within the parent
+     * texture.
+     *
+     * @default 0
+     **/
+    y?: number;
+    /**
+     * The width of the sub-texture in pixels.
+     *
+     * @default 0
+     */
+    width?: number;
+    /**
+     * The height of the sub-texture in pixels
+     **/
+    height?: number;
+}
+/**
+ * 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 declare class SubTexture extends Texture {
+    props: Required<SubTextureProps>;
+    parentTexture: Texture;
+    type: TextureType;
+    constructor(txManager: CoreTextureManager, props: SubTextureProps);
+    private onParentTxLoaded;
+    private onParentTxFailed;
+    private onParentTxFetched;
+    private onParentTxFetching;
+    private onParentTxLoading;
+    private onParentTxFreed;
+    private forwardParentTxState;
+    onChangeIsRenderable(isRenderable: boolean): void;
+    getTextureSource(): Promise<TextureData>;
+    static makeCacheKey(props: SubTextureProps): string | false;
+    static resolveDefaults(props: SubTextureProps): Required<SubTextureProps>;
+    static z$__type__Props: SubTextureProps;
+}