@lightningjs/renderer 2.11.1 → 2.12.0

package/src/core/text-rendering/font-face-types/utils.ts

@@ -0,0 +1,39 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2020 Metrological
+ *
+ * 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 function fetchJson(
+  url: string,
+  responseType: XMLHttpRequestResponseType = '',
+): Promise<unknown> {
+  return new Promise((resolve, reject) => {
+    const xhr = new XMLHttpRequest();
+    xhr.responseType = responseType;
+    xhr.onreadystatechange = function () {
+      if (xhr.readyState == XMLHttpRequest.DONE) {
+        // On most devices like WebOS and Tizen, the file protocol returns 0 while http(s) protocol returns 200
+        if (xhr.status === 0 || xhr.status === 200) {
+          resolve(xhr.response);
+        } else {
+          reject(xhr.statusText);
+        }
+      }
+    };
+    xhr.open('GET', url, true);
+    xhr.send(null);
+  });
+}

package/src/core/textures/ImageTexture.ts

@@ -25,6 +25,7 @@ import {
 } 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';
 
 /**
  * Properties of the {@link ImageTexture}
@@ -220,7 +221,9 @@ export class ImageTexture extends Texture {
         );
       }
 
-      const blob = await fetch(src).then((response) => response.blob());
+      const blob = await fetchJson(src, 'blob').then(
+        (response) => response as Blob,
+      );
       return this.createImageBitmap(blob, premultiplyAlpha, sx, sy, sw, sh);
     }
 

package/src/core/textures/SubTexture.ts

@@ -137,14 +137,10 @@ export class SubTexture extends Texture {
       width: this.props.width,
       height: this.props.height,
     });
-
-    // free our source, if any
-    this.freeTextureData();
   };
 
   private onParentTxFailed: TextureFailedEventHandler = (target, error) => {
     this.forwardParentTxState('failed', error);
-    this.free();
   };
 
   private onParentTxFetched = () => {
@@ -164,7 +160,6 @@ export class SubTexture extends Texture {
 
   private onParentTxFreed = () => {
     this.forwardParentTxState('freed');
-    this.free();
   };
 
   private forwardParentTxState(
@@ -182,24 +177,9 @@ export class SubTexture extends Texture {
   override async getTextureSource(): Promise<TextureData> {
     // Check if parent texture is loaded
     return new Promise((resolve, reject) => {
-      if (this.parentTexture.state === 'loaded') {
-        resolve({
-          data: this.props,
-        });
-      }
-
-      this.parentTexture.once('loaded', (target, data) => {
-        resolve({
-          data: this.props,
-        });
-      });
-
-      this.parentTexture.once('failed', (target, error) => {
-        reject(error);
-      });
-
-      this.parentTexture.once('freed', () => {
-        reject(new Error('Parent texture was freed'));
+      this.setState('fetched');
+      resolve({
+        data: this.props,
       });
     });
   }

package/src/core/textures/Texture.ts

@@ -200,15 +200,6 @@ export abstract class Texture extends EventEmitter {
   }
 
   load(): void {
-    if (
-      this.state === 'fetching' ||
-      this.state === 'loading' ||
-      this.state === 'loaded' ||
-      this.state === 'failed'
-    ) {
-      return;
-    }
-
     this.txManager.loadTexture(this);
   }
 
@@ -245,7 +236,6 @@ export abstract class Texture extends EventEmitter {
    */
   free(): void {
     this.ctxTexture?.free();
-    this.textureData = null;
   }
 
   /**

package/src/main-api/Renderer.ts

@@ -319,6 +319,8 @@ export interface RendererMainSettings {
  *   - Emitted every `fpsUpdateInterval` milliseconds with the current FPS
  * - `frameTick`
  *   - Emitted every frame tick
+ * - `quadsUpdate`
+ *  - Emitted when number of quads rendered is updated
  * - `idle`
  *   - Emitted when the renderer is idle (no changes to the scene
  *     graph/animations running)
@@ -687,6 +689,26 @@ export class RendererMain extends EventEmitter {
     this.stage.requestRender();
   }
 
+  /**
+   * Cleanup textures that are not being used
+   *
+   * @remarks
+   * This can be used to free up GFX memory used by textures that are no longer
+   * being displayed.
+   *
+   * This routine is also called automatically when the memory used by textures
+   * exceeds the critical threshold on frame generation **OR** when the renderer
+   * is idle and the memory used by textures exceeds the target threshold.
+   *
+   * **NOTE**: This is a heavy operation and should be used sparingly.
+   * **NOTE2**: This will not cleanup textures that are currently being displayed.
+   * **NOTE3**: This will not cleanup textures that are marked as `preventCleanup`.
+   * **NOTE4**: This has nothing to do with the garbage collection of JavaScript.
+   */
+  cleanup() {
+    this.stage.cleanup();
+  }
+
   /**
    * Sets the clear color for the stage.
    *