@lightningjs/renderer 0.7.1 → 0.7.3

package/src/core/textures/ColorTexture.ts

@@ -1,86 +1,86 @@
-/*
- * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
-import { Texture, type TextureData } from './Texture.js';
-
-/**
- * Properties of the {@link ColorTexture}
- */
-export interface ColorTextureProps {
-  /**
-   * Color to use to generate the texture
-   *
-   * @default 0xffffffff (opaque white)
-   */
-  color?: number;
-}
-
-/**
- * Texture consisting of only a 1x1 color pixel
- *
- * @remarks
- * The pixel color is set with the {@link ColorTextureProps.color} prop.
- *
- * This is the default texture used for a Node if it's
- * {@link INodeWritableProps.texture} prop is set to `null` (the default)
- *
- * Generally the 1x1 color pixel is stretched to whatever the set dimensions of
- * a Node are.
- */
-export class ColorTexture extends Texture {
-  props: Required<ColorTextureProps>;
-
-  constructor(txManager: CoreTextureManager, props?: ColorTextureProps) {
-    super(txManager);
-    this.props = ColorTexture.resolveDefaults(props || {});
-  }
-
-  get color() {
-    return this.props.color;
-  }
-
-  set color(color: number) {
-    this.props.color = color;
-  }
-
-  override async getTextureData(): Promise<TextureData> {
-    const pixelData32 = new Uint32Array([this.color]);
-    const pixelData8 = new Uint8ClampedArray(pixelData32.buffer);
-    return {
-      data: new ImageData(pixelData8, 1, 1),
-      premultiplyAlpha: true,
-    };
-  }
-
-  static override makeCacheKey(props: ColorTextureProps): string {
-    const resolvedProps = ColorTexture.resolveDefaults(props);
-    return `ColorTexture,${resolvedProps.color}`;
-  }
-
-  static override resolveDefaults(
-    props: ColorTextureProps,
-  ): Required<ColorTextureProps> {
-    return {
-      color: props.color || 0xffffffff,
-    };
-  }
-
-  static z$__type__Props: ColorTextureProps;
-}
+/*
+ * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, type TextureData } from './Texture.js';
+
+/**
+ * Properties of the {@link ColorTexture}
+ */
+export interface ColorTextureProps {
+  /**
+   * Color to use to generate the texture
+   *
+   * @default 0xffffffff (opaque white)
+   */
+  color?: number;
+}
+
+/**
+ * Texture consisting of only a 1x1 color pixel
+ *
+ * @remarks
+ * The pixel color is set with the {@link ColorTextureProps.color} prop.
+ *
+ * This is the default texture used for a Node if it's
+ * {@link INodeWritableProps.texture} prop is set to `null` (the default)
+ *
+ * Generally the 1x1 color pixel is stretched to whatever the set dimensions of
+ * a Node are.
+ */
+export class ColorTexture extends Texture {
+  props: Required<ColorTextureProps>;
+
+  constructor(txManager: CoreTextureManager, props?: ColorTextureProps) {
+    super(txManager);
+    this.props = ColorTexture.resolveDefaults(props || {});
+  }
+
+  get color() {
+    return this.props.color;
+  }
+
+  set color(color: number) {
+    this.props.color = color;
+  }
+
+  override async getTextureData(): Promise<TextureData> {
+    const pixelData32 = new Uint32Array([this.color]);
+    const pixelData8 = new Uint8ClampedArray(pixelData32.buffer);
+    return {
+      data: new ImageData(pixelData8, 1, 1),
+      premultiplyAlpha: true,
+    };
+  }
+
+  static override makeCacheKey(props: ColorTextureProps): string {
+    const resolvedProps = ColorTexture.resolveDefaults(props);
+    return `ColorTexture,${resolvedProps.color}`;
+  }
+
+  static override resolveDefaults(
+    props: ColorTextureProps,
+  ): Required<ColorTextureProps> {
+    return {
+      color: props.color || 0xffffffff,
+    };
+  }
+
+  static z$__type__Props: ColorTextureProps;
+}

package/src/core/textures/ImageTexture.ts

@@ -1,124 +1,133 @@
-/*
- * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
-import { Texture, 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;
-  /**
-   * 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;
-}
-
-/**
- * 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: Required<ImageTextureProps>;
-
-  constructor(txManager: CoreTextureManager, props: ImageTextureProps) {
-    super(txManager);
-    this.props = ImageTexture.resolveDefaults(props);
-  }
-
-  override async getTextureData(): Promise<TextureData> {
-    const { src, premultiplyAlpha } = this.props;
-    if (!src) {
-      return {
-        data: null,
-      };
-    }
-    if (src instanceof ImageData) {
-      return {
-        data: src,
-        premultiplyAlpha,
-      };
-    }
-
-    if (this.txManager.imageWorkerManager.imageWorkersEnabled) {
-      return await this.txManager.imageWorkerManager.getImage(
-        src,
-        premultiplyAlpha,
-      );
-    } else {
-      const response = await fetch(src);
-      const blob = await response.blob();
-      return {
-        data: await createImageBitmap(blob, {
-          premultiplyAlpha: premultiplyAlpha ? 'premultiply' : 'none',
-          colorSpaceConversion: 'none',
-          imageOrientation: 'none',
-        }),
-      };
-    }
-  }
-
-  static override makeCacheKey(props: ImageTextureProps): string | false {
-    const resolvedProps = ImageTexture.resolveDefaults(props);
-    // ImageTextures sourced by ImageData are non-cacheable
-    if (resolvedProps.src instanceof ImageData) {
-      return false;
-    }
-    return `ImageTexture,${resolvedProps.src},${resolvedProps.premultiplyAlpha}`;
-  }
-
-  static override resolveDefaults(
-    props: ImageTextureProps,
-  ): Required<ImageTextureProps> {
-    return {
-      src: props.src ?? '',
-      premultiplyAlpha: props.premultiplyAlpha ?? true,
-    };
-  }
-
-  static z$__type__Props: ImageTextureProps;
-}
+/*
+ * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, type TextureData } from './Texture.js';
+import {
+  isCompressedTextureContainer,
+  loadCompressedTexture,
+} from '../lib/textureCompression.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;
+  /**
+   * 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;
+}
+
+/**
+ * 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: Required<ImageTextureProps>;
+
+  constructor(txManager: CoreTextureManager, props: ImageTextureProps) {
+    super(txManager);
+    this.props = ImageTexture.resolveDefaults(props);
+  }
+
+  override async getTextureData(): Promise<TextureData> {
+    const { src, premultiplyAlpha } = this.props;
+    if (!src) {
+      return {
+        data: null,
+      };
+    }
+    if (src instanceof ImageData) {
+      return {
+        data: src,
+        premultiplyAlpha,
+      };
+    }
+
+    // Handle compressed textures
+    if (isCompressedTextureContainer(src)) {
+      return loadCompressedTexture(src);
+    }
+
+    if (this.txManager.imageWorkerManager.imageWorkersEnabled) {
+      return await this.txManager.imageWorkerManager.getImage(
+        src,
+        premultiplyAlpha,
+      );
+    } else {
+      const response = await fetch(src);
+      const blob = await response.blob();
+      return {
+        data: await createImageBitmap(blob, {
+          premultiplyAlpha: premultiplyAlpha ? 'premultiply' : 'none',
+          colorSpaceConversion: 'none',
+          imageOrientation: 'none',
+        }),
+      };
+    }
+  }
+
+  static override makeCacheKey(props: ImageTextureProps): string | false {
+    const resolvedProps = ImageTexture.resolveDefaults(props);
+    // ImageTextures sourced by ImageData are non-cacheable
+    if (resolvedProps.src instanceof ImageData) {
+      return false;
+    }
+    return `ImageTexture,${resolvedProps.src},${resolvedProps.premultiplyAlpha}`;
+  }
+
+  static override resolveDefaults(
+    props: ImageTextureProps,
+  ): Required<ImageTextureProps> {
+    return {
+      src: props.src ?? '',
+      premultiplyAlpha: props.premultiplyAlpha ?? true,
+    };
+  }
+
+  static z$__type__Props: ImageTextureProps;
+}

package/src/core/textures/NoiseTexture.ts

@@ -1,96 +1,96 @@
-/*
- * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
-import { Texture, 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 class NoiseTexture extends Texture {
-  props: Required<NoiseTextureProps>;
-
-  constructor(txManager: CoreTextureManager, props: NoiseTextureProps) {
-    super(txManager);
-    this.props = NoiseTexture.resolveDefaults(props);
-  }
-
-  override async getTextureData(): Promise<TextureData> {
-    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;
-    }
-    return {
-      data: new ImageData(pixelData8, width, height),
-    };
-  }
-
-  static override makeCacheKey(props: NoiseTextureProps): string {
-    const resolvedProps = NoiseTexture.resolveDefaults(props);
-    return `NoiseTexture,${resolvedProps.width},${resolvedProps.height},${resolvedProps.cacheId}`;
-  }
-
-  static override resolveDefaults(
-    props: NoiseTextureProps,
-  ): Required<NoiseTextureProps> {
-    return {
-      width: props.width ?? 128,
-      height: props.height ?? 128,
-      cacheId: props.cacheId ?? 0,
-    };
-  }
-
-  static z$__type__Props: NoiseTextureProps;
-}
+/*
+ * 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 type { CoreTextureManager } from '../CoreTextureManager.js';
+import { Texture, 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 class NoiseTexture extends Texture {
+  props: Required<NoiseTextureProps>;
+
+  constructor(txManager: CoreTextureManager, props: NoiseTextureProps) {
+    super(txManager);
+    this.props = NoiseTexture.resolveDefaults(props);
+  }
+
+  override async getTextureData(): Promise<TextureData> {
+    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;
+    }
+    return {
+      data: new ImageData(pixelData8, width, height),
+    };
+  }
+
+  static override makeCacheKey(props: NoiseTextureProps): string {
+    const resolvedProps = NoiseTexture.resolveDefaults(props);
+    return `NoiseTexture,${resolvedProps.width},${resolvedProps.height},${resolvedProps.cacheId}`;
+  }
+
+  static override resolveDefaults(
+    props: NoiseTextureProps,
+  ): Required<NoiseTextureProps> {
+    return {
+      width: props.width ?? 128,
+      height: props.height ?? 128,
+      cacheId: props.cacheId ?? 0,
+    };
+  }
+
+  static z$__type__Props: NoiseTextureProps;
+}