@lightningjs/blits 1.21.0 → 1.22.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v1.22.0
+
+_3 mar 2025_
+
+- Added default value for `createImageBitmapSupport` to `auto`
+- Added advanced launch settings
+
+## v1.21.1
+
+_28 feb 2025_
+
+- Changed gpuMemory launch settings to be optional in type definitions
+
 ## v1.21.0
 
 _27 feb 2025_

package/docs/transitions_animations/transitions.md

@@ -128,7 +128,7 @@ export default Blits.Component('Gold', {
   }
 ```
 
-It is also possible to keep track of the entire progress of a transition. Every frametick during a transition (ideally once every 1.6ms), the renderer reports the progress of the transition. You can hook into this event by specifying a `progress` key on the transition configuration object, with a function to excute.
+It is also possible to keep track of the entire progress of a transition. Every frametick during a transition (ideally once every 16ms), the renderer reports the progress of the transition. You can hook into this event by specifying a `progress` key on the transition configuration object, with a function to excute.
 
 This function is executed _every_ frametick, and receives the current progress and the previous progress as its arguments. The progress is indicated as a value between `0` and `1`, where 0 means start and 1 means finished.
 

package/index.d.ts

@@ -18,7 +18,7 @@
 // blits file type reference
 /// <reference path="./blits.d.ts" />
 
-import {type ShaderEffect as RendererShaderEffect, type WebGlCoreShader} from '@lightningjs/renderer'
+import {type ShaderEffect as RendererShaderEffect, type WebGlCoreShader, type RendererMainSettings} from '@lightningjs/renderer'
 
 declare module '@lightningjs/blits' {
 
@@ -806,7 +806,7 @@ declare module '@lightningjs/blits' {
     /**
      * Configures the gpu memory settings used by the renderer
      */
-    gpuMemory: {
+    gpuMemory?: {
       /**
        * Maximum GPU memory threshold (in `mb`) after which
        * the renderer will immediately start cleaning up textures to free
@@ -816,7 +816,7 @@ declare module '@lightningjs/blits' {
        *
        * @default `200`
        */
-      max: number,
+      max?: number,
       /**
        * Target threshold of GPU memory usage, defined as a fraction of
        * the max threshold. The renderer will attempt to keep memory
@@ -824,13 +824,13 @@ declare module '@lightningjs/blits' {
        *
        * @default `0.8`
        */
-      target: 0.8,
+      target?: number,
       /**
        * Interval at which regular texture cleanups occur (in `ms`)
        *
        * @default `5000`
        */
-      cleanupInterval: 5000,
+      cleanupInterval?: number,
       /**
        * Baseline GPU memory usage of the App (in `mb`), without rendering any
        * textures. This value will be used as a basis when calculating
@@ -839,7 +839,7 @@ declare module '@lightningjs/blits' {
        *
        * @default `25`
        */
-      baseline: 25,
+      baseline?: number,
       /**
        * Whether or not the max threshold should be considered
        * as a strict number that can not be exceeded in any way
@@ -850,7 +850,7 @@ declare module '@lightningjs/blits' {
        *
        * @default false
        */
-      strict: false,
+      strict?: boolean,
     },
     /**
      * Defines which mode the renderer should operate in: `webgl` or `canvas`
@@ -886,7 +886,14 @@ declare module '@lightningjs/blits' {
      *
      * Defaults to `10`
      */
-    textureProcessingTimeLimit?: number
+    textureProcessingTimeLimit?: number,
+    /**
+     * Advanced renderer settings to override Blits launch settings, or configure
+     * settings that are not officially exposed in Blits yet
+     *
+     * @important if you dont know what you're doing here, you probably shouldn't be doing it!
+     */
+    advanced?: Partial<RendererMainSettings>
   }
 
   interface State {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/blits",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "description": "Blits: The Lightning 3 App Development Framework",
   "bin": "bin/index.js",
   "exports": {

package/src/engines/L3/launch.js

@@ -66,28 +66,32 @@ const textureMemorySettings = (settings) => {
 export default (App, target, settings = {}) => {
   renderer = new RendererMain(
     {
-      appWidth: settings.w || 1920,
-      appHeight: settings.h || 1080,
-      fpsUpdateInterval: settings.fpsInterval || 1000,
-      devicePhysicalPixelRatio:
-        RENDER_QUALITIES[settings.renderQuality] || settings.renderQuality || 1,
-      deviceLogicalPixelRatio:
-        settings.pixelRatio ||
-        SCREEN_RESOLUTIONS[settings.screenResolution] ||
-        SCREEN_RESOLUTIONS[window.innerHeight] ||
-        1,
-      numImageWorkers:
-        'webWorkersLimit' in settings
-          ? settings.webWorkersLimit
-          : window.navigator.hardwareConcurrency || 2,
-      clearColor: (settings.canvasColor && colors.normalize(settings.canvasColor)) || 0x00000000,
-      inspector: settings.inspector === true ? Inspector : undefined,
-      boundsMargin: settings.viewportMargin || 0,
-      renderEngine: renderEngine(settings),
-      fontEngines: textRenderEngines(settings),
-      canvas: settings.canvas,
-      textureProcessingTimeLimit: settings.textureProcessingTimeLimit,
-      textureMemory: textureMemorySettings(settings),
+      ...{
+        appWidth: settings.w || 1920,
+        appHeight: settings.h || 1080,
+        fpsUpdateInterval: settings.fpsInterval || 1000,
+        devicePhysicalPixelRatio:
+          RENDER_QUALITIES[settings.renderQuality] || settings.renderQuality || 1,
+        deviceLogicalPixelRatio:
+          settings.pixelRatio ||
+          SCREEN_RESOLUTIONS[settings.screenResolution] ||
+          SCREEN_RESOLUTIONS[window.innerHeight] ||
+          1,
+        numImageWorkers:
+          'webWorkersLimit' in settings
+            ? settings.webWorkersLimit
+            : window.navigator.hardwareConcurrency || 2,
+        clearColor: (settings.canvasColor && colors.normalize(settings.canvasColor)) || 0x00000000,
+        inspector: settings.inspector === true ? Inspector : undefined,
+        boundsMargin: settings.viewportMargin || 0,
+        renderEngine: renderEngine(settings),
+        fontEngines: textRenderEngines(settings),
+        canvas: settings.canvas,
+        textureProcessingTimeLimit: settings.textureProcessingTimeLimit,
+        textureMemory: textureMemorySettings(settings),
+        createImageBitmapSupport: 'auto',
+      },
+      ...(settings.advanced || {}),
     },
     target
   )