@lightningjs/blits 1.30.2 → 1.31.0

package/src/engines/L3/fontLoader.js

@@ -1,38 +1,38 @@
-import { SdfTrFontFace, WebTrFontFace } from '@lightningjs/renderer'
-import Settings from '../../settings.js'
-import { renderer } from './launch.js'
-
-export default () => {
-  const stage = renderer.stage
-  Settings.get('fonts', []).forEach((font) => {
-    if (font.type === 'sdf' || font.type === 'msdf') {
-      // automatically map png key to file name
-      if (!font.png && font.file) {
-        font.png = font.file.replace(/\.[^.]+$/, `.${font.type}.png`)
-      }
-      // automatically map json to file name
-      if (!font.json && font.file) {
-        font.json = font.file.replace(/\.[^.]+$/, `.${font.type}.json`)
-      }
-      stage.fontManager.addFontFace(
-        new SdfTrFontFace(font.type, {
-          fontFamily: font.family,
-          descriptors: {},
-          atlasUrl: font.png,
-          atlasDataUrl: font.json,
-          stage,
-          metrics: font.metrics,
-        })
-      )
-    } else if (font.type === 'web') {
-      stage.fontManager.addFontFace(
-        new WebTrFontFace({
-          fontFamily: font.family,
-          fontUrl: font.file,
-          descriptors: {},
-          metrics: font.metrics,
-        })
-      )
-    }
-  })
-}
+import { SdfTrFontFace, WebTrFontFace } from '@lightningjs/renderer'
+import Settings from '../../settings.js'
+import { renderer } from './launch.js'
+
+export default () => {
+  const stage = renderer.stage
+  Settings.get('fonts', []).forEach((font) => {
+    if (font.type === 'sdf' || font.type === 'msdf') {
+      // automatically map png key to file name
+      if (!font.png && font.file) {
+        font.png = font.file.replace(/\.[^.]+$/, `.${font.type}.png`)
+      }
+      // automatically map json to file name
+      if (!font.json && font.file) {
+        font.json = font.file.replace(/\.[^.]+$/, `.${font.type}.json`)
+      }
+      stage.fontManager.addFontFace(
+        new SdfTrFontFace(font.type, {
+          fontFamily: font.family,
+          descriptors: {},
+          atlasUrl: font.png,
+          atlasDataUrl: font.json,
+          stage,
+          metrics: font.metrics,
+        })
+      )
+    } else if (font.type === 'web') {
+      stage.fontManager.addFontFace(
+        new WebTrFontFace({
+          fontFamily: font.family,
+          fontUrl: font.file,
+          descriptors: {},
+          metrics: font.metrics,
+        })
+      )
+    }
+  })
+}

package/src/engines/L3/index.js

@@ -1,7 +1,7 @@
-import Element from './element.js'
-import Launch from './launch.js'
-
-export default {
-  Element,
-  Launch,
-}
+import Element from './element.js'
+import Launch from './launch.js'
+
+export default {
+  Element,
+  Launch,
+}

package/src/engines/L3/launch.js

@@ -1,123 +1,123 @@
-/*
- * 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { RendererMain } from '@lightningjs/renderer'
-import { WebGlCoreRenderer, SdfTextRenderer } from '@lightningjs/renderer/webgl'
-import { CanvasCoreRenderer, CanvasTextRenderer } from '@lightningjs/renderer/canvas'
-import { Inspector } from '@lightningjs/renderer/inspector'
-
-import { Log } from '../../lib/log.js'
-import { SCREEN_RESOLUTIONS, RENDER_QUALITIES } from '../../constants.js'
-import colors from '../../lib/colors/colors.js'
-import fontLoader from './fontLoader.js'
-import shaderLoader from './shaderLoader.js'
-
-/** @type {RendererMain|null} */
-export let renderer = null
-
-const renderEngine = (settings) => {
-  const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
-
-  if (renderMode === 'webgl') return WebGlCoreRenderer
-  if (renderMode === 'canvas') return CanvasCoreRenderer
-}
-
-const textRenderEngines = (settings) => {
-  const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
-
-  if (renderMode === 'webgl') return [SdfTextRenderer, CanvasTextRenderer]
-  if (renderMode === 'canvas') return [CanvasTextRenderer]
-}
-
-const textureMemorySettings = (settings) => {
-  const gpuMemory = {
-    ...{
-      max: 200,
-      target: 0.8,
-      cleanupInterval: 5000,
-      baseline: 25,
-      strict: false,
-    },
-    ...('gpuMemory' in settings === true ? settings.gpuMemory : {}),
-  }
-
-  return {
-    criticalThreshold: gpuMemory.max * 1024 * 1024, // convert from mb to bytes
-    targetThresholdLevel: gpuMemory.target,
-    cleanupInterval: gpuMemory.cleanupInterval,
-    baselineMemoryAllocation: gpuMemory.baseline * 1024 * 1024, // convert from mb to bytes
-    doNotExceedCriticalThreshold: gpuMemory.strict,
-  }
-}
-
-/**
- * Launch the render engine and application
- *
- * @param {import('../../launch.js').BlitsAppFactory} App - Factory function that returns the application instance (extends BlitsComponent with .quit())
- * @param {HTMLElement} target - The target element to render the application into
- * @param {Partial<import('../../launch.js').BlitsSettings>} [settings] - The settings for the renderer
- *
- */
-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),
-        createImageBitmapSupport: 'auto',
-      },
-      ...(settings.advanced || {}),
-    },
-    target
-  )
-
-  const initApp = () => {
-    let app = App()
-    app.quit = () => {
-      Log.info('Closing App')
-      app.destroy()
-      app = null
-      renderer = null
-    }
-  }
-
-  shaderLoader()
-  fontLoader()
-  initApp()
-
-  return renderer
-}
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { RendererMain } from '@lightningjs/renderer'
+import { WebGlCoreRenderer, SdfTextRenderer } from '@lightningjs/renderer/webgl'
+import { CanvasCoreRenderer, CanvasTextRenderer } from '@lightningjs/renderer/canvas'
+import { Inspector } from '@lightningjs/renderer/inspector'
+
+import { Log } from '../../lib/log.js'
+import { SCREEN_RESOLUTIONS, RENDER_QUALITIES } from '../../constants.js'
+import colors from '../../lib/colors/colors.js'
+import fontLoader from './fontLoader.js'
+import shaderLoader from './shaderLoader.js'
+
+/** @type {RendererMain|null} */
+export let renderer = null
+
+const renderEngine = (settings) => {
+  const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
+
+  if (renderMode === 'webgl') return WebGlCoreRenderer
+  if (renderMode === 'canvas') return CanvasCoreRenderer
+}
+
+const textRenderEngines = (settings) => {
+  const renderMode = 'renderMode' in settings ? settings.renderMode : 'webgl'
+
+  if (renderMode === 'webgl') return [SdfTextRenderer, CanvasTextRenderer]
+  if (renderMode === 'canvas') return [CanvasTextRenderer]
+}
+
+const textureMemorySettings = (settings) => {
+  const gpuMemory = {
+    ...{
+      max: 200,
+      target: 0.8,
+      cleanupInterval: 5000,
+      baseline: 25,
+      strict: false,
+    },
+    ...('gpuMemory' in settings === true ? settings.gpuMemory : {}),
+  }
+
+  return {
+    criticalThreshold: gpuMemory.max * 1024 * 1024, // convert from mb to bytes
+    targetThresholdLevel: gpuMemory.target,
+    cleanupInterval: gpuMemory.cleanupInterval,
+    baselineMemoryAllocation: gpuMemory.baseline * 1024 * 1024, // convert from mb to bytes
+    doNotExceedCriticalThreshold: gpuMemory.strict,
+  }
+}
+
+/**
+ * Launch the render engine and application
+ *
+ * @param {import('../../launch.js').BlitsAppFactory} App - Factory function that returns the application instance (extends BlitsComponent with .quit())
+ * @param {HTMLElement} target - The target element to render the application into
+ * @param {Partial<import('../../launch.js').BlitsSettings>} [settings] - The settings for the renderer
+ *
+ */
+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),
+        createImageBitmapSupport: 'auto',
+      },
+      ...(settings.advanced || {}),
+    },
+    target
+  )
+
+  const initApp = () => {
+    let app = App()
+    app.quit = () => {
+      Log.info('Closing App')
+      app.destroy()
+      app = null
+      renderer = null
+    }
+  }
+
+  shaderLoader()
+  fontLoader()
+  initApp()
+
+  return renderer
+}

package/src/engines/L3/shaderLoader.js

@@ -1,12 +1,12 @@
-import Settings from '../../settings.js'
-import { renderer } from './launch.js'
-
-export default () => {
-  const stage = renderer.stage
-  Settings.get('shaders', []).forEach((shader) => {
-    stage.shManager.registerShaderType(shader.name, shader.type)
-  })
-  Settings.get('effects', []).forEach((effect) => {
-    stage.shManager.registerShaderType(effect.name, effect.type)
-  })
-}
+import Settings from '../../settings.js'
+import { renderer } from './launch.js'
+
+export default () => {
+  const stage = renderer.stage
+  Settings.get('shaders', []).forEach((shader) => {
+    stage.shManager.registerShaderType(shader.name, shader.type)
+  })
+  Settings.get('effects', []).forEach((effect) => {
+    stage.shManager.registerShaderType(effect.name, effect.type)
+  })
+}

package/src/engines/index.js

@@ -1 +1 @@
-export { default as L3 } from './L3/index.js'
+export { default as L3 } from './L3/index.js'

package/src/focus.js

@@ -1,90 +1,90 @@
-/*
- * 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import symbols from './lib/symbols.js'
-import { state } from './router/router.js'
-import Settings from './settings.js'
-import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
-
-let focusedComponent = null
-let focusChain = []
-let setFocusTimeout
-
-export const keyUpCallbacks = new Map()
-
-export default {
-  _hold: false,
-  set hold(v) {
-    this._hold = v
-  },
-  get hold() {
-    return this._hold
-  },
-  get() {
-    return focusedComponent
-  },
-  set(component, event) {
-    if (component === focusedComponent) return
-    clearTimeout(setFocusTimeout)
-    focusedComponent && focusedComponent !== component.parent && focusedComponent.unfocus()
-    focusChain.reverse().forEach((cmp) => cmp.unfocus())
-    if (component !== focusedComponent) {
-      setFocusTimeout = setTimeout(
-        () => {
-          focusedComponent = component
-          focusedComponent.lifecycle.state = 'focus'
-          if (event instanceof KeyboardEvent) {
-            document.dispatchEvent(new KeyboardEvent('keydown', event))
-          } else {
-            focusChain = []
-          }
-        },
-        this.hold ? Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS) : 0
-      )
-    }
-  },
-  input(key, event) {
-    if (state.navigating === true) return
-    focusChain = walkChain([focusedComponent], key)
-    const componentWithInputEvent = focusChain.shift()
-
-    if (componentWithInputEvent) {
-      let cb
-      if (componentWithInputEvent[symbols.inputEvents][key]) {
-        cb = componentWithInputEvent[symbols.inputEvents][key].call(componentWithInputEvent, event)
-      } else if (componentWithInputEvent[symbols.inputEvents].any) {
-        cb = componentWithInputEvent[symbols.inputEvents].any.call(componentWithInputEvent, event)
-      }
-      if (cb !== undefined) {
-        keyUpCallbacks.set(event.code, cb)
-      }
-    }
-  },
-}
-
-const walkChain = (components, key) => {
-  if (
-    components[0][symbols.inputEvents] &&
-    (typeof components[0][symbols.inputEvents][key] === 'function' ||
-      typeof components[0][symbols.inputEvents].any === 'function')
-  ) {
-    return components
-  } else if (components[0].parent) {
-    components.unshift(components[0].parent)
-    return walkChain(components, key)
-  } else return []
-}
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import symbols from './lib/symbols.js'
+import { state } from './router/router.js'
+import Settings from './settings.js'
+import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
+
+let focusedComponent = null
+let focusChain = []
+let setFocusTimeout
+
+export const keyUpCallbacks = new Map()
+
+export default {
+  _hold: false,
+  set hold(v) {
+    this._hold = v
+  },
+  get hold() {
+    return this._hold
+  },
+  get() {
+    return focusedComponent
+  },
+  set(component, event) {
+    if (component === focusedComponent) return
+    clearTimeout(setFocusTimeout)
+    focusedComponent && focusedComponent !== component.parent && focusedComponent.unfocus()
+    focusChain.reverse().forEach((cmp) => cmp.unfocus())
+    if (component !== focusedComponent) {
+      setFocusTimeout = setTimeout(
+        () => {
+          focusedComponent = component
+          focusedComponent.lifecycle.state = 'focus'
+          if (event instanceof KeyboardEvent) {
+            document.dispatchEvent(new KeyboardEvent('keydown', event))
+          } else {
+            focusChain = []
+          }
+        },
+        this.hold ? Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS) : 0
+      )
+    }
+  },
+  input(key, event) {
+    if (state.navigating === true) return
+    focusChain = walkChain([focusedComponent], key)
+    const componentWithInputEvent = focusChain.shift()
+
+    if (componentWithInputEvent) {
+      let cb
+      if (componentWithInputEvent[symbols.inputEvents][key]) {
+        cb = componentWithInputEvent[symbols.inputEvents][key].call(componentWithInputEvent, event)
+      } else if (componentWithInputEvent[symbols.inputEvents].any) {
+        cb = componentWithInputEvent[symbols.inputEvents].any.call(componentWithInputEvent, event)
+      }
+      if (cb !== undefined) {
+        keyUpCallbacks.set(event.code, cb)
+      }
+    }
+  },
+}
+
+const walkChain = (components, key) => {
+  if (
+    components[0][symbols.inputEvents] &&
+    (typeof components[0][symbols.inputEvents][key] === 'function' ||
+      typeof components[0][symbols.inputEvents].any === 'function')
+  ) {
+    return components
+  } else if (components[0].parent) {
+    components.unshift(components[0].parent)
+    return walkChain(components, key)
+  } else return []
+}

package/src/helpers/deepEqualArray.js

@@ -1,50 +1,50 @@
-/*
- * 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.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-const deepEqualArray = (array1, array2) => {
-  if (array1 === array2) return true
-  if (array1.length !== array2.length) return false
-
-  let l = array1.length
-
-  while (l--) {
-    const value1 = array1[l]
-    const value2 = array2[l]
-
-    // values are arrays, deepEqual nested arrays
-    if (Array.isArray(value1) && Array.isArray(value2)) {
-      if (deepEqualArray(value1, value2) === false) return false
-    }
-    // values are objects, deepEqual nested objects
-    else if (
-      typeof value1 === 'object' &&
-      value1 !== null &&
-      typeof value2 === 'object' &&
-      value2 !== null
-    ) {
-      if (deepEqualArray(Object.entries(value1), Object.entries(value2)) === false) return false
-    }
-    // other type, do strict equal check
-    else if (value1 !== value2) {
-      return false
-    }
-  }
-
-  return true
-}
-
-export default deepEqualArray
+/*
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const deepEqualArray = (array1, array2) => {
+  if (array1 === array2) return true
+  if (array1.length !== array2.length) return false
+
+  let l = array1.length
+
+  while (l--) {
+    const value1 = array1[l]
+    const value2 = array2[l]
+
+    // values are arrays, deepEqual nested arrays
+    if (Array.isArray(value1) && Array.isArray(value2)) {
+      if (deepEqualArray(value1, value2) === false) return false
+    }
+    // values are objects, deepEqual nested objects
+    else if (
+      typeof value1 === 'object' &&
+      value1 !== null &&
+      typeof value2 === 'object' &&
+      value2 !== null
+    ) {
+      if (deepEqualArray(Object.entries(value1), Object.entries(value2)) === false) return false
+    }
+    // other type, do strict equal check
+    else if (value1 !== value2) {
+      return false
+    }
+  }
+
+  return true
+}
+
+export default deepEqualArray