@lightningjs/renderer 2.12.1 → 2.13.0

package/src/core/lib/validateImageBitmap.ts

@@ -0,0 +1,76 @@
+export interface CreateImageBitmapSupport {
+  basic: boolean; // Supports createImageBitmap(image)
+  options: boolean; // Supports createImageBitmap(image, options)
+  full: boolean; // Supports createImageBitmap(image, sx, sy, sw, sh, options)
+}
+
+export async function validateCreateImageBitmap(): Promise<CreateImageBitmapSupport> {
+  // Test if createImageBitmap is supported using a simple 1x1 PNG image
+  // prettier-ignore
+  const pngBinaryData = new Uint8Array([
+      0x89, 0x50, 0x4e, 0x47,
+      0x0d, 0x0a, 0x1a, 0x0a, // PNG signature
+      0x00, 0x00, 0x00, 0x0d, // IHDR chunk length
+      0x49, 0x48, 0x44, 0x52, // "IHDR" chunk type
+      0x00, 0x00, 0x00, 0x01, // Width: 1
+      0x00, 0x00, 0x00, 0x01, // Height: 1
+      0x01,                   // Bit depth: 1
+      0x03,                   // Color type: Indexed
+      0x00,                   // Compression method: Deflate
+      0x00,                   // Filter method: None
+      0x00,                   // Interlace method: None
+      0x25, 0xdb, 0x56, 0xca, // CRC for IHDR
+      0x00, 0x00, 0x00, 0x03, // PLTE chunk length
+      0x50, 0x4c, 0x54, 0x45, // "PLTE" chunk type
+      0x00, 0x00, 0x00,       // Palette entry: Black
+      0xa7, 0x7a, 0x3d, 0xda, // CRC for PLTE
+      0x00, 0x00, 0x00, 0x01, // tRNS chunk length
+      0x74, 0x52, 0x4e, 0x53, // "tRNS" chunk type
+      0x00,                   // Transparency for black: Fully transparent
+      0x40, 0xe6, 0xd8, 0x66, // CRC for tRNS
+      0x00, 0x00, 0x00, 0x0a, // IDAT chunk length
+      0x49, 0x44, 0x41, 0x54, // "IDAT" chunk type
+      0x08, 0xd7,             // Deflate header
+      0x63, 0x60, 0x00, 0x00,
+      0x00, 0x02, 0x00, 0x01, // Zlib-compressed data
+      0xe2, 0x21, 0xbc, 0x33, // CRC for IDAT
+      0x00, 0x00, 0x00, 0x00, // IEND chunk length
+      0x49, 0x45, 0x4e, 0x44, // "IEND" chunk type
+      0xae, 0x42, 0x60, 0x82, // CRC for IEND
+    ]);
+
+  const support: CreateImageBitmapSupport = {
+    basic: false,
+    options: false,
+    full: false,
+  };
+
+  // Test basic createImageBitmap support
+  const blob = new Blob([pngBinaryData], { type: 'image/png' });
+  const bitmap = await createImageBitmap(blob);
+  bitmap.close?.();
+  support.basic = true;
+
+  // Test createImageBitmap with options support
+  try {
+    const options = { premultiplyAlpha: 'none' as const };
+    const bitmapWithOptions = await createImageBitmap(blob, options);
+    bitmapWithOptions.close?.();
+    support.options = true;
+  } catch (e) {
+    /* ignore */
+  }
+
+  // Test createImageBitmap with full options support
+  try {
+    const bitmapWithFullOptions = await createImageBitmap(blob, 0, 0, 1, 1, {
+      premultiplyAlpha: 'none',
+    });
+    bitmapWithFullOptions.close?.();
+    support.full = true;
+  } catch (e) {
+    /* ignore */
+  }
+
+  return support;
+}

package/src/core/platform.ts

@@ -1,61 +1,63 @@
-/*
- * 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 { Stage } from './Stage.js';
-
-/**
- * Platform render loop initiator
- */
-export const startLoop = (stage: Stage) => {
-  let isIdle = false;
-  const runLoop = () => {
-    stage.updateFrameTime();
-    stage.updateAnimations();
-
-    if (!stage.hasSceneUpdates()) {
-      // We still need to calculate the fps else it looks like the app is frozen
-      stage.calculateFps();
-      setTimeout(runLoop, 16.666666666666668);
-
-      if (!isIdle) {
-        if (stage.txMemManager.checkCleanup()) {
-          stage.txMemManager.cleanup();
-        }
-        stage.eventBus.emit('idle');
-        isIdle = true;
-      }
-      stage.flushFrameEvents();
-      return;
-    }
-
-    isIdle = false;
-    stage.drawFrame();
-    stage.flushFrameEvents();
-    requestAnimationFrame(runLoop);
-  };
-  requestAnimationFrame(runLoop);
-};
-
-/**
- * Return unix timestamp
- * @return {number}
- */
-export const getTimeStamp = () => {
-  return performance ? performance.now() : Date.now();
-};
+/*
+ * 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 { Stage } from './Stage.js';
+
+/**
+ * Platform render loop initiator
+ */
+export const startLoop = (stage: Stage) => {
+  let isIdle = false;
+  const runLoop = () => {
+    stage.updateFrameTime();
+    stage.updateAnimations();
+
+    if (!stage.hasSceneUpdates()) {
+      // We still need to calculate the fps else it looks like the app is frozen
+      stage.calculateFps();
+      setTimeout(runLoop, 16.666666666666668);
+
+      if (!isIdle) {
+        stage.eventBus.emit('idle');
+        isIdle = true;
+      }
+
+      if (stage.txMemManager.checkCleanup() === true) {
+        stage.txMemManager.cleanup(false);
+      }
+
+      stage.flushFrameEvents();
+      return;
+    }
+
+    isIdle = false;
+    stage.drawFrame();
+    stage.flushFrameEvents();
+    requestAnimationFrame(runLoop);
+  };
+  requestAnimationFrame(runLoop);
+};
+
+/**
+ * Return unix timestamp
+ * @return {number}
+ */
+export const getTimeStamp = () => {
+  return performance ? performance.now() : Date.now();
+};

package/src/core/renderers/CoreContextTexture.ts

@@ -1,43 +1,43 @@
-/*
- * 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 { TextureMemoryManager } from '../TextureMemoryManager.js';
-import type { Texture } from '../textures/Texture.js';
-
-export abstract class CoreContextTexture {
-  readonly textureSource: Texture;
-  private memManager: TextureMemoryManager;
-  public state: 'freed' | 'loading' | 'loaded' | 'failed' = 'freed';
-
-  constructor(memManager: TextureMemoryManager, textureSource: Texture) {
-    this.memManager = memManager;
-    this.textureSource = textureSource;
-  }
-
-  protected setTextureMemUse(byteSize: number): void {
-    this.memManager.setTextureMemUse(this.textureSource, byteSize);
-  }
-
-  abstract load(): void;
-  abstract free(): void;
-
-  get renderable(): boolean {
-    return this.textureSource.renderable;
-  }
-}
+/*
+ * 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 { TextureMemoryManager } from '../TextureMemoryManager.js';
+import type { Texture } from '../textures/Texture.js';
+
+export abstract class CoreContextTexture {
+  readonly textureSource: Texture;
+  private memManager: TextureMemoryManager;
+  public state: 'freed' | 'loading' | 'loaded' | 'failed' = 'freed';
+
+  constructor(memManager: TextureMemoryManager, textureSource: Texture) {
+    this.memManager = memManager;
+    this.textureSource = textureSource;
+  }
+
+  protected setTextureMemUse(byteSize: number): void {
+    this.memManager.setTextureMemUse(this.textureSource, byteSize);
+  }
+
+  abstract load(): void;
+  abstract free(): void;
+
+  get renderable(): boolean {
+    return this.textureSource.renderable;
+  }
+}

package/src/core/renderers/CoreRenderOp.ts

@@ -1,22 +1,22 @@
-/*
- * 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.
- */
-
-export abstract class CoreRenderOp {
-  abstract draw(): void;
-}
+/*
+ * 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.
+ */
+
+export abstract class CoreRenderOp {
+  abstract draw(): void;
+}

package/src/core/renderers/CoreRenderer.ts

@@ -1,115 +1,115 @@
-/*
- * 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 { Dimensions } from '../../common/CommonTypes.js';
-import type { BaseShaderController } from '../../main-api/ShaderController.js';
-import type { CoreNode } from '../CoreNode.js';
-import type { CoreShaderManager } from '../CoreShaderManager.js';
-import type {
-  CoreTextureManager,
-  TextureOptions,
-} from '../CoreTextureManager.js';
-import type { Stage } from '../Stage.js';
-import type { TextureMemoryManager } from '../TextureMemoryManager.js';
-import type { ContextSpy } from '../lib/ContextSpy.js';
-import type { RenderCoords } from '../lib/RenderCoords.js';
-import type { RectWithValid } from '../lib/utils.js';
-import type { Texture } from '../textures/Texture.js';
-import { CoreContextTexture } from './CoreContextTexture.js';
-import type { CoreShader } from './CoreShader.js';
-
-export interface QuadOptions {
-  width: number;
-  height: number;
-  colorTl: number;
-  colorTr: number;
-  colorBl: number;
-  colorBr: number;
-  texture: Texture | null;
-  textureOptions: TextureOptions | null;
-  zIndex: number;
-  shader: CoreShader | null;
-  shaderProps: Record<string, unknown> | null;
-  alpha: number;
-  clippingRect: RectWithValid;
-  tx: number;
-  ty: number;
-  ta: number;
-  tb: number;
-  tc: number;
-  td: number;
-  renderCoords?: RenderCoords;
-  rtt?: boolean;
-  parentHasRenderTexture?: boolean;
-  framebufferDimensions?: Dimensions;
-}
-
-export interface CoreRendererOptions {
-  stage: Stage;
-  canvas: HTMLCanvasElement | OffscreenCanvas;
-  pixelRatio: number;
-  txManager: CoreTextureManager;
-  txMemManager: TextureMemoryManager;
-  shManager: CoreShaderManager;
-  clearColor: number;
-  bufferMemory: number;
-  contextSpy: ContextSpy | null;
-  forceWebGL2: boolean;
-}
-
-export interface BufferInfo {
-  totalUsed: number;
-  totalAvailable: number;
-}
-
-export abstract class CoreRenderer {
-  public options: CoreRendererOptions;
-  public mode: 'webgl' | 'canvas' | undefined;
-
-  readonly stage: Stage;
-
-  //// Core Managers
-  txManager: CoreTextureManager;
-  txMemManager: TextureMemoryManager;
-  shManager: CoreShaderManager;
-  rttNodes: CoreNode[] = [];
-
-  constructor(options: CoreRendererOptions) {
-    this.options = options;
-    this.stage = options.stage;
-    this.txManager = options.txManager;
-    this.txMemManager = options.txMemManager;
-    this.shManager = options.shManager;
-  }
-
-  abstract reset(): void;
-  abstract render(surface?: 'screen' | CoreContextTexture): void;
-  abstract addQuad(quad: QuadOptions): void;
-  abstract createCtxTexture(textureSource: Texture): CoreContextTexture;
-  abstract getShaderManager(): CoreShaderManager;
-  abstract get renderToTextureActive(): boolean;
-  abstract get activeRttNode(): CoreNode | null;
-  abstract renderRTTNodes(): void;
-  abstract removeRTTNode(node: CoreNode): void;
-  abstract renderToTexture(node: CoreNode): void;
-  abstract getBufferInfo(): BufferInfo | null;
-  abstract getQuadCount(): number | null;
-  abstract getDefShaderCtr(): BaseShaderController;
-  abstract updateClearColor(color: number): void;
-}
+/*
+ * 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 { Dimensions } from '../../common/CommonTypes.js';
+import type { BaseShaderController } from '../../main-api/ShaderController.js';
+import type { CoreNode } from '../CoreNode.js';
+import type { CoreShaderManager } from '../CoreShaderManager.js';
+import type {
+  CoreTextureManager,
+  TextureOptions,
+} from '../CoreTextureManager.js';
+import type { Stage } from '../Stage.js';
+import type { TextureMemoryManager } from '../TextureMemoryManager.js';
+import type { ContextSpy } from '../lib/ContextSpy.js';
+import type { RenderCoords } from '../lib/RenderCoords.js';
+import type { RectWithValid } from '../lib/utils.js';
+import type { Texture } from '../textures/Texture.js';
+import { CoreContextTexture } from './CoreContextTexture.js';
+import type { CoreShader } from './CoreShader.js';
+
+export interface QuadOptions {
+  width: number;
+  height: number;
+  colorTl: number;
+  colorTr: number;
+  colorBl: number;
+  colorBr: number;
+  texture: Texture | null;
+  textureOptions: TextureOptions | null;
+  zIndex: number;
+  shader: CoreShader | null;
+  shaderProps: Record<string, unknown> | null;
+  alpha: number;
+  clippingRect: RectWithValid;
+  tx: number;
+  ty: number;
+  ta: number;
+  tb: number;
+  tc: number;
+  td: number;
+  renderCoords?: RenderCoords;
+  rtt?: boolean;
+  parentHasRenderTexture?: boolean;
+  framebufferDimensions?: Dimensions;
+}
+
+export interface CoreRendererOptions {
+  stage: Stage;
+  canvas: HTMLCanvasElement | OffscreenCanvas;
+  pixelRatio: number;
+  txManager: CoreTextureManager;
+  txMemManager: TextureMemoryManager;
+  shManager: CoreShaderManager;
+  clearColor: number;
+  bufferMemory: number;
+  contextSpy: ContextSpy | null;
+  forceWebGL2: boolean;
+}
+
+export interface BufferInfo {
+  totalUsed: number;
+  totalAvailable: number;
+}
+
+export abstract class CoreRenderer {
+  public options: CoreRendererOptions;
+  public mode: 'webgl' | 'canvas' | undefined;
+
+  readonly stage: Stage;
+
+  //// Core Managers
+  txManager: CoreTextureManager;
+  txMemManager: TextureMemoryManager;
+  shManager: CoreShaderManager;
+  rttNodes: CoreNode[] = [];
+
+  constructor(options: CoreRendererOptions) {
+    this.options = options;
+    this.stage = options.stage;
+    this.txManager = options.txManager;
+    this.txMemManager = options.txMemManager;
+    this.shManager = options.shManager;
+  }
+
+  abstract reset(): void;
+  abstract render(surface?: 'screen' | CoreContextTexture): void;
+  abstract addQuad(quad: QuadOptions): void;
+  abstract createCtxTexture(textureSource: Texture): CoreContextTexture;
+  abstract getShaderManager(): CoreShaderManager;
+  abstract get renderToTextureActive(): boolean;
+  abstract get activeRttNode(): CoreNode | null;
+  abstract renderRTTNodes(): void;
+  abstract removeRTTNode(node: CoreNode): void;
+  abstract renderToTexture(node: CoreNode): void;
+  abstract getBufferInfo(): BufferInfo | null;
+  abstract getQuadCount(): number | null;
+  abstract getDefShaderCtr(): BaseShaderController;
+  abstract updateClearColor(color: number): void;
+}

package/src/core/renderers/CoreShader.ts

@@ -1,41 +1,41 @@
-/*
- * 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 { CoreRenderOp } from './CoreRenderOp.js';
-
-export abstract class CoreShader {
-  // abstract draw(): void;
-  static makeCacheKey(props: Record<string, unknown>): string | false {
-    return false;
-  }
-
-  static resolveDefaults(
-    props: Record<string, unknown>,
-  ): Record<string, unknown> {
-    return {};
-  }
-
-  abstract bindRenderOp(
-    renderOp: CoreRenderOp,
-    props: Record<string, unknown> | null,
-  ): void;
-  protected abstract bindProps(props: Record<string, unknown>): void;
-  abstract attach(): void;
-  abstract detach(): void;
-}
+/*
+ * 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 { CoreRenderOp } from './CoreRenderOp.js';
+
+export abstract class CoreShader {
+  // abstract draw(): void;
+  static makeCacheKey(props: Record<string, unknown>): string | false {
+    return false;
+  }
+
+  static resolveDefaults(
+    props: Record<string, unknown>,
+  ): Record<string, unknown> {
+    return {};
+  }
+
+  abstract bindRenderOp(
+    renderOp: CoreRenderOp,
+    props: Record<string, unknown> | null,
+  ): void;
+  protected abstract bindProps(props: Record<string, unknown>): void;
+  abstract attach(): void;
+  abstract detach(): void;
+}