@lightningjs/renderer 0.8.2 → 0.8.4

package/src/core/renderers/CoreRenderer.ts

@@ -17,13 +17,20 @@
  * limitations under the License.
  */
 
+import type { Dimensions } from '../../common/CommonTypes.js';
+import type { CoreNode } from '../CoreNode.js';
 import type { CoreShaderManager } from '../CoreShaderManager.js';
-import type { TextureOptions } from '../CoreTextureManager.js';
+import type {
+  CoreTextureManager,
+  TextureOptions,
+} from '../CoreTextureManager.js';
 import type { Stage } from '../Stage.js';
-import type { Rect, RectWithValid } from '../lib/utils.js';
+import type { TextureMemoryManager } from '../TextureMemoryManager.js';
+import type { ContextSpy } from '../lib/ContextSpy.js';
+import type { RectWithValid } from '../lib/utils.js';
+import { ColorTexture } from '../textures/ColorTexture.js';
 import type { Texture } from '../textures/Texture.js';
 import { CoreContextTexture } from './CoreContextTexture.js';
-import type { CoreRenderOp } from './CoreRenderOp.js';
 import type { CoreShader } from './CoreShader.js';
 
 export interface QuadOptions {
@@ -46,18 +53,51 @@ export interface QuadOptions {
   tb: number;
   tc: number;
   td: number;
+  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;
 }
 
 export abstract class CoreRenderer {
+  public options: CoreRendererOptions;
+  public mode: 'webgl' | 'canvas' | undefined;
+
   protected stage: Stage;
 
-  constructor(stage: Stage) {
-    this.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 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;
 }

package/src/core/renderers/canvas/CanvasCoreRenderer.ts

@@ -0,0 +1,223 @@
+/*
+ * 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 { CoreNode } from '../../CoreNode.js';
+import type { CoreShaderManager } from '../../CoreShaderManager.js';
+import { getRgbaComponents, type RGBA } from '../../lib/utils.js';
+import { SubTexture } from '../../textures/SubTexture.js';
+import type { Texture } from '../../textures/Texture.js';
+import type { CoreContextTexture } from '../CoreContextTexture.js';
+import {
+  CoreRenderer,
+  type CoreRendererOptions,
+  type QuadOptions,
+} from '../CoreRenderer.js';
+import { CanvasCoreTexture } from './CanvasCoreTexture.js';
+import { getRadius } from './internal/C2DShaderUtils.js';
+import {
+  formatRgba,
+  parseColor,
+  type IParsedColor,
+} from './internal/ColorUtils.js';
+
+export class CanvasCoreRenderer extends CoreRenderer {
+  private context: CanvasRenderingContext2D;
+  private canvas: HTMLCanvasElement;
+  private pixelRatio: number;
+  private clearColor: RGBA | undefined;
+  public renderToTextureActive = false;
+  activeRttNode: CoreNode | null = null;
+  constructor(options: CoreRendererOptions) {
+    super(options);
+
+    this.mode = 'canvas';
+    this.shManager.renderer = this;
+
+    const { canvas, pixelRatio, clearColor } = options;
+    this.canvas = canvas as HTMLCanvasElement;
+    this.context = canvas.getContext('2d') as CanvasRenderingContext2D;
+    this.pixelRatio = pixelRatio;
+    this.clearColor = clearColor ? getRgbaComponents(clearColor) : undefined;
+  }
+
+  reset(): void {
+    // eslint-disable-next-line no-self-assign
+    this.canvas.width = this.canvas.width; // quick reset canvas
+
+    const ctx = this.context;
+
+    if (this.clearColor) {
+      const [r, g, b, a] = this.clearColor;
+      ctx.fillStyle = `rgba(${r}, ${g}, ${b}, ${a / 255})`;
+      ctx.fillRect(0, 0, this.canvas.width, this.canvas.height);
+    }
+
+    ctx.scale(this.pixelRatio, this.pixelRatio);
+  }
+
+  render(): void {
+    // noop
+  }
+
+  addQuad(quad: QuadOptions): void {
+    const ctx = this.context;
+    const {
+      tx,
+      ty,
+      width,
+      height,
+      alpha,
+      colorTl,
+      colorTr,
+      colorBr,
+      ta,
+      tb,
+      tc,
+      td,
+      clippingRect,
+    } = quad;
+    let texture = quad.texture;
+    let ctxTexture: CanvasCoreTexture | undefined = undefined;
+    let frame:
+      | { x: number; y: number; width: number; height: number }
+      | undefined;
+
+    if (texture) {
+      if (texture instanceof SubTexture) {
+        frame = texture.props;
+        texture = texture.parentTexture;
+      }
+
+      ctxTexture = this.txManager.getCtxTexture(texture) as CanvasCoreTexture;
+      if (texture.state === 'freed') {
+        ctxTexture.load();
+        return;
+      }
+      if (texture.state !== 'loaded' || !ctxTexture.hasImage()) {
+        return;
+      }
+    }
+
+    const color = parseColor(colorTl);
+    const hasTransform = ta !== 1;
+    const hasClipping = clippingRect.width !== 0 && clippingRect.height !== 0;
+    const hasGradient = colorTl !== colorTr || colorTl !== colorBr;
+    const radius = quad.shader ? getRadius(quad) : 0;
+
+    if (hasTransform || hasClipping || radius) {
+      ctx.save();
+    }
+
+    if (hasClipping) {
+      const path = new Path2D();
+      const { x, y, width, height } = clippingRect;
+      path.rect(x, y, width, height);
+      ctx.clip(path);
+    }
+
+    if (hasTransform) {
+      // Quad transform:
+      // | ta tb tx |
+      // | tc td ty |
+      // | 0  0  1  |
+      // C2D transform:
+      // | a  c  e  |
+      // | b  d  f  |
+      // | 0  0  1  |
+      const scale = this.pixelRatio;
+      ctx.setTransform(ta, tc, tb, td, tx * scale, ty * scale);
+      ctx.scale(scale, scale);
+      ctx.translate(-tx, -ty);
+    }
+
+    if (radius) {
+      const path = new Path2D();
+      path.roundRect(tx, ty, width, height, radius);
+      ctx.clip(path);
+    }
+
+    if (ctxTexture) {
+      const image = ctxTexture.getImage(color);
+      ctx.globalAlpha = alpha;
+      if (frame) {
+        ctx.drawImage(
+          image,
+          frame.x,
+          frame.y,
+          frame.width,
+          frame.height,
+          tx,
+          ty,
+          width,
+          height,
+        );
+      } else {
+        ctx.drawImage(image, tx, ty, width, height);
+      }
+      ctx.globalAlpha = 1;
+    } else if (hasGradient) {
+      let endX: number = tx;
+      let endY: number = ty;
+      let endColor: IParsedColor;
+      if (colorTl === colorTr) {
+        // vertical
+        endX = tx;
+        endY = ty + height;
+        endColor = parseColor(colorBr);
+      } else {
+        // horizontal
+        endX = tx + width;
+        endY = ty;
+        endColor = parseColor(colorTr);
+      }
+      const gradient = ctx.createLinearGradient(tx, ty, endX, endY);
+      gradient.addColorStop(0, formatRgba(color));
+      gradient.addColorStop(1, formatRgba(endColor));
+      ctx.fillStyle = gradient;
+      ctx.fillRect(tx, ty, width, height);
+    } else {
+      ctx.fillStyle = formatRgba(color);
+      ctx.fillRect(tx, ty, width, height);
+    }
+
+    if (hasTransform || hasClipping || radius) {
+      ctx.restore();
+    }
+  }
+
+  createCtxTexture(textureSource: Texture): CoreContextTexture {
+    return new CanvasCoreTexture(this.txMemManager, textureSource);
+  }
+
+  getShaderManager(): CoreShaderManager {
+    return this.shManager;
+  }
+
+  renderRTTNodes(): void {
+    // noop
+  }
+
+  removeRTTNode(node: CoreNode): void {
+    // noop
+  }
+
+  renderToTexture(node: CoreNode): void {
+    // noop
+  }
+}

package/src/core/renderers/canvas/CanvasCoreTexture.ts

@@ -0,0 +1,144 @@
+/*
+ * 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 { assertTruthy } from '../../../utils.js';
+import { CoreContextTexture } from '../CoreContextTexture.js';
+import { formatRgba, type IParsedColor } from './internal/ColorUtils.js';
+
+export class CanvasCoreTexture extends CoreContextTexture {
+  protected image: ImageBitmap | HTMLCanvasElement | undefined;
+  protected tintCache:
+    | {
+        key: string;
+        image: HTMLCanvasElement;
+      }
+    | undefined;
+
+  load(): void {
+    if (this.textureSource.state !== 'freed') {
+      return;
+    }
+    this.textureSource.setState('loading');
+    this.onLoadRequest()
+      .then((size) => {
+        this.textureSource.setState('loaded', size);
+        this.updateMemSize();
+      })
+      .catch((err) => {
+        this.textureSource.setState('failed', err as Error);
+      });
+  }
+
+  free(): void {
+    this.image = undefined;
+    this.tintCache = undefined;
+    this.textureSource.setState('freed');
+    this.memManager.setTextureMemUse(this, 0);
+  }
+
+  updateMemSize(): void {
+    // Counting memory usage for:
+    // - main image
+    // - tinted image
+    const mult = this.tintCache ? 8 : 4;
+    if (this.textureSource.dimensions) {
+      const { width, height } = this.textureSource.dimensions;
+      this.memManager.setTextureMemUse(this, width * height * mult);
+    }
+  }
+
+  hasImage(): boolean {
+    return this.image !== undefined;
+  }
+
+  getImage(color: IParsedColor): ImageBitmap | HTMLCanvasElement {
+    const image = this.image;
+    assertTruthy(image, 'Attempt to get unloaded image texture');
+
+    if (color.isWhite) {
+      if (this.tintCache) {
+        this.tintCache = undefined;
+        this.updateMemSize();
+      }
+      return image;
+    }
+    const key = formatRgba(color);
+    if (this.tintCache?.key === key) {
+      return this.tintCache.image;
+    }
+
+    const tintedImage = this.tintTexture(image, key);
+    this.tintCache = {
+      key,
+      image: tintedImage,
+    };
+    this.updateMemSize();
+    return tintedImage;
+  }
+
+  protected tintTexture(
+    source: ImageBitmap | HTMLCanvasElement,
+    color: string,
+  ) {
+    const { width, height } = source;
+    const canvas = document.createElement('canvas');
+    canvas.width = width;
+    canvas.height = height;
+    const ctx = canvas.getContext('2d');
+    if (ctx) {
+      // fill with target color
+      ctx.fillStyle = color;
+      ctx.globalCompositeOperation = 'copy';
+      ctx.fillRect(0, 0, width, height);
+
+      // multiply with image, resulting in non-transparent tinted image
+      ctx.globalCompositeOperation = 'multiply';
+      ctx.drawImage(source, 0, 0, width, height, 0, 0, width, height);
+
+      // apply original image alpha
+      ctx.globalCompositeOperation = 'destination-in';
+      ctx.drawImage(source, 0, 0, width, height, 0, 0, width, height);
+    }
+    return canvas;
+  }
+
+  get renderable(): boolean {
+    return this.textureSource.renderable;
+  }
+
+  private async onLoadRequest(): Promise<Dimensions> {
+    const { data } = await this.textureSource.getTextureData();
+    // TODO: canvas from text renderer should be able to provide the canvas directly
+    // instead of having to re-draw it into a new canvas...
+    if (data instanceof ImageData) {
+      const canvas = document.createElement('canvas');
+      canvas.width = data.width;
+      canvas.height = data.height;
+      const ctx = canvas.getContext('2d');
+      if (ctx) ctx.putImageData(data, 0, 0);
+      this.image = canvas;
+      return { width: data.width, height: data.height };
+    } else if (data instanceof ImageBitmap) {
+      this.image = data;
+      return { width: data.width, height: data.height };
+    }
+    return { width: 0, height: 0 };
+  }
+}

package/src/core/renderers/canvas/internal/C2DShaderUtils.ts

@@ -0,0 +1,37 @@
+/*
+ * 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 { QuadOptions } from '../../CoreRenderer.js';
+import {
+  ROUNDED_RECTANGLE_SHADER_TYPE,
+  UnsupportedShader,
+} from '../shaders/UnsupportedShader.js';
+
+/**
+ * Extract `RoundedRectangle` shader radius to apply as a clipping
+ */
+export function getRadius(quad: QuadOptions): number {
+  if (quad.shader instanceof UnsupportedShader) {
+    const shType = quad.shader.shType;
+    if (shType === ROUNDED_RECTANGLE_SHADER_TYPE) {
+      return (quad.shaderProps?.radius as number) ?? 0;
+    }
+  }
+  return 0;
+}

package/src/core/renderers/canvas/internal/ColorUtils.ts

@@ -0,0 +1,55 @@
+/*
+ * 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 interface IParsedColor {
+  isWhite: boolean;
+  a: number;
+  r: number;
+  g: number;
+  b: number;
+}
+
+const WHITE: IParsedColor = {
+  isWhite: true,
+  a: 1,
+  r: 0xff,
+  g: 0xff,
+  b: 0xff,
+};
+
+/**
+ * Extract color components
+ */
+export function parseColor(abgr: number): IParsedColor {
+  if (abgr === 0xffffffff) {
+    return WHITE;
+  }
+  const a = ((abgr >>> 24) & 0xff) / 255;
+  const b = (abgr >>> 16) & 0xff & 0xff;
+  const g = (abgr >>> 8) & 0xff & 0xff;
+  const r = abgr & 0xff & 0xff;
+  return { isWhite: false, a, r, g, b };
+}
+
+/**
+ * Format a parsed color into a rgba CSS color
+ */
+export function formatRgba({ a, r, g, b }: IParsedColor): string {
+  return `rgba(${r},${g},${b},${a})`;
+}

package/src/core/renderers/canvas/shaders/UnsupportedShader.ts

@@ -0,0 +1,48 @@
+/*
+ * 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 { CoreShader } from '../../CoreShader.js';
+
+export const ROUNDED_RECTANGLE_SHADER_TYPE = 'RoundedRectangle';
+
+export class UnsupportedShader extends CoreShader {
+  public shType: string;
+
+  constructor(shType: string) {
+    super();
+    this.shType = shType;
+    if (shType !== ROUNDED_RECTANGLE_SHADER_TYPE) {
+      console.warn('Unsupported shader:', shType);
+    }
+  }
+
+  bindRenderOp(): void {
+    // noop
+  }
+  protected bindProps(): void {
+    // noop
+  }
+
+  attach(): void {
+    // noop
+  }
+  detach(): void {
+    // noop
+  }
+}

package/src/core/renderers/webgl/WebGlCoreCtxRenderTexture.ts

@@ -0,0 +1,79 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2024 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 { assertTruthy } from '../../../utils.js';
+import type { TextureMemoryManager } from '../../TextureMemoryManager.js';
+import type { WebGlContextWrapper } from '../../lib/WebGlContextWrapper.js';
+import type { RenderTexture } from '../../textures/RenderTexture.js';
+import { WebGlCoreCtxTexture } from './WebGlCoreCtxTexture.js';
+
+export class WebGlCoreCtxRenderTexture extends WebGlCoreCtxTexture {
+  declare textureSource: RenderTexture;
+
+  readonly framebuffer: WebGLFramebuffer;
+
+  constructor(
+    glw: WebGlContextWrapper,
+    memManager: TextureMemoryManager,
+    textureSource: RenderTexture,
+  ) {
+    super(glw, memManager, textureSource);
+    // Create Framebuffer object
+    const framebuffer = glw.createFramebuffer();
+    assertTruthy(framebuffer, 'Unable to create framebuffer');
+    this.framebuffer = framebuffer;
+  }
+
+  override async onLoadRequest(): Promise<Dimensions> {
+    const { glw, memManager } = this;
+    const nativeTexture = (this._nativeCtxTexture =
+      this.createNativeCtxTexture());
+    const { width, height } = this.textureSource;
+
+    // Set the dimensions of the render texture
+    glw.texImage2D(
+      0,
+      glw.RGBA,
+      width,
+      height,
+      0,
+      glw.RGBA,
+      glw.UNSIGNED_BYTE,
+      null,
+    );
+
+    // Update the texture memory manager
+    memManager.setTextureMemUse(this, width * height * 4);
+
+    // Bind the framebuffer
+    glw.bindFramebuffer(this.framebuffer);
+
+    // Attach the texture to the framebuffer
+    glw.framebufferTexture2D(glw.COLOR_ATTACHMENT0, nativeTexture, 0);
+
+    // Unbind the framebuffer
+    glw.bindFramebuffer(null);
+
+    return {
+      width,
+      height,
+    };
+  }
+}