@luma.gl/core 9.0.0-beta.3 → 9.0.0-beta.5

package/dist/lib/compiler-log/format-compiler-log.js

@@ -1,64 +1,82 @@
+/** @returns annotated errors or warnings */
 export function formatCompilerLog(shaderLog, source, options) {
-  let formattedLog = '';
-  const lines = source.split(/\r?\n/);
-  const log = shaderLog.slice().sort((a, b) => a.lineNum - b.lineNum);
-  switch ((options === null || options === void 0 ? void 0 : options.showSourceCode) || 'no') {
-    case 'all':
-      let currentMessage = 0;
-      for (let lineNum = 1; lineNum <= lines.length; lineNum++) {
-        formattedLog += getNumberedLine(lines[lineNum - 1], lineNum, options);
-        while (log.length > currentMessage && log[currentMessage].lineNum === lineNum) {
-          const message = log[currentMessage++];
-          formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
-            ...options,
-            inlineSource: false
-          });
-        }
-      }
-      return formattedLog;
-    case 'issues':
-    case 'no':
-      for (const message of shaderLog) {
-        formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
-          inlineSource: (options === null || options === void 0 ? void 0 : options.showSourceCode) !== 'no'
-        });
-      }
-      return formattedLog;
-  }
+    let formattedLog = '';
+    const lines = source.split(/\r?\n/);
+    const log = shaderLog.slice().sort((a, b) => a.lineNum - b.lineNum);
+    switch (options?.showSourceCode || 'no') {
+        case 'all':
+            // Parse the error - note: browser and driver dependent
+            let currentMessage = 0;
+            for (let lineNum = 1; lineNum <= lines.length; lineNum++) {
+                formattedLog += getNumberedLine(lines[lineNum - 1], lineNum, options);
+                while (log.length > currentMessage && log[currentMessage].lineNum === lineNum) {
+                    const message = log[currentMessage++];
+                    formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
+                        ...options,
+                        inlineSource: false
+                    });
+                }
+            }
+            return formattedLog;
+        case 'issues':
+        case 'no':
+            // Parse the error - note: browser and driver dependent
+            for (const message of shaderLog) {
+                formattedLog += formatCompilerMessage(message, lines, message.lineNum, {
+                    inlineSource: options?.showSourceCode !== 'no'
+                });
+            }
+            return formattedLog;
+    }
 }
+// Helpers
+/** Format one message */
 function formatCompilerMessage(message, lines, lineNum, options) {
-  if (options !== null && options !== void 0 && options.inlineSource) {
-    const numberedLines = getNumberedLines(lines, lineNum);
-    const positionIndicator = message.linePos > 0 ? `${' '.repeat(message.linePos + 5)}^^^\n` : '';
-    return `
+    if (options?.inlineSource) {
+        const numberedLines = getNumberedLines(lines, lineNum);
+        // If we got error position on line add a `^^^` indicator on next line
+        const positionIndicator = message.linePos > 0 ? `${' '.repeat(message.linePos + 5)}^^^\n` : '';
+        return `
 ${numberedLines}${positionIndicator}${message.type.toUpperCase()}: ${message.message}
 
 `;
-  }
-  return options !== null && options !== void 0 && options.html ? `<div class='luma-compiler-log-error' style="color:red;"><b> ${message.type.toUpperCase()}: ${message.message}</b></div>` : `${message.type.toUpperCase()}: ${message.message}`;
+    }
+    return options?.html
+        ? `<div class='luma-compiler-log-error' style="color:red;"><b> ${message.type.toUpperCase()}: ${message.message}</b></div>`
+        : `${message.type.toUpperCase()}: ${message.message}`;
 }
 function getNumberedLines(lines, lineNum, options) {
-  let numberedLines = '';
-  for (let lineIndex = lineNum - 2; lineIndex <= lineNum; lineIndex++) {
-    const sourceLine = lines[lineIndex - 1];
-    if (sourceLine !== undefined) {
-      numberedLines += getNumberedLine(sourceLine, lineNum, options);
+    let numberedLines = '';
+    for (let lineIndex = lineNum - 2; lineIndex <= lineNum; lineIndex++) {
+        const sourceLine = lines[lineIndex - 1];
+        if (sourceLine !== undefined) {
+            numberedLines += getNumberedLine(sourceLine, lineNum, options);
+        }
     }
-  }
-  return numberedLines;
+    return numberedLines;
 }
 function getNumberedLine(line, lineNum, options) {
-  const escapedLine = options !== null && options !== void 0 && options.html ? escapeHTML(line) : line;
-  return `${padLeft(String(lineNum), 4)}: ${escapedLine}${options !== null && options !== void 0 && options.html ? '<br/>' : '\n'}`;
+    const escapedLine = options?.html ? escapeHTML(line) : line;
+    return `${padLeft(String(lineNum), 4)}: ${escapedLine}${options?.html ? '<br/>' : '\n'}`;
 }
+/**
+ * Pads a string with a number of spaces (space characters) to the left
+ * @param {String} string - string to pad
+ * @param {Number} digits - number of spaces to add
+ * @return {String} string - The padded string
+ */
 function padLeft(string, paddedLength) {
-  let result = '';
-  for (let i = string.length; i < paddedLength; ++i) {
-    result += ' ';
-  }
-  return result + string;
+    let result = '';
+    for (let i = string.length; i < paddedLength; ++i) {
+        result += ' ';
+    }
+    return result + string;
 }
 function escapeHTML(unsafe) {
-  return unsafe.replaceAll('&', '&amp;').replaceAll('<', '&lt;').replaceAll('>', '&gt;').replaceAll('"', '&quot;').replaceAll('\'', '&#039;');
+    return unsafe
+        .replaceAll('&', '&amp;')
+        .replaceAll('<', '&lt;')
+        .replaceAll('>', '&gt;')
+        .replaceAll('"', '&quot;')
+        .replaceAll('\'', '&#039;');
 }
-//# sourceMappingURL=format-compiler-log.js.map

package/dist/lib/compiler-log/get-shader-info.js

@@ -1,25 +1,28 @@
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+/** Extracts information from shader source code */
 export function getShaderInfo(source, defaultName) {
-  return {
-    name: getShaderName(source, defaultName),
-    language: 'glsl',
-    version: getShaderVersion(source)
-  };
+    return {
+        name: getShaderName(source, defaultName),
+        language: 'glsl',
+        version: getShaderVersion(source)
+    };
 }
-function getShaderName(shader) {
-  let defaultName = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'unnamed';
-  const SHADER_NAME_REGEXP = /#define[\s*]SHADER_NAME[\s*]([A-Za-z0-9_-]+)[\s*]/;
-  const match = SHADER_NAME_REGEXP.exec(shader);
-  return match ? match[1] : defaultName;
+/** Extracts GLSLIFY style naming of shaders: `#define SHADER_NAME ...` */
+function getShaderName(shader, defaultName = 'unnamed') {
+    const SHADER_NAME_REGEXP = /#define[\s*]SHADER_NAME[\s*]([A-Za-z0-9_-]+)[\s*]/;
+    const match = SHADER_NAME_REGEXP.exec(shader);
+    return match ? match[1] : defaultName;
 }
+/** returns GLSL shader version of given shader string */
 function getShaderVersion(source) {
-  let version = 100;
-  const words = source.match(/[^\s]+/g);
-  if (words && words.length >= 2 && words[0] === '#version') {
-    const v = parseInt(words[1], 10);
-    if (Number.isFinite(v)) {
-      version = v;
+    let version = 100;
+    const words = source.match(/[^\s]+/g);
+    if (words && words.length >= 2 && words[0] === '#version') {
+        const v = parseInt(words[1], 10);
+        if (Number.isFinite(v)) {
+            version = v;
+        }
     }
-  }
-  return version;
+    return version;
 }
-//# sourceMappingURL=get-shader-info.js.map

package/dist/lib/luma.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"luma.d.ts","sourceRoot":"","sources":["../../src/lib/luma.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAC,MAAM,EAAC,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAQpD;;;;GAIG;AACH,qBAAa,IAAI;IACf,mCAAmC;IACnC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAa;IAEvC,iBAAiB;IACjB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAO;IAEtB,MAAM,CAAC,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,GAAyB,IAAI;IAOxE,MAAM,CAAC,mBAAmB,IAAI,MAAM,EAAE;IAKtC,MAAM,CAAC,mBAAmB,IAAI,MAAM,EAAE;IAKtC,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAItD,wCAAwC;WAC3B,YAAY,CAAC,KAAK,GAAE,WAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAmCpE"}
+{"version":3,"file":"luma.d.ts","sourceRoot":"","sources":["../../src/lib/luma.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,eAAe,CAAC;AACvC,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AACnD,OAAO,EAAC,MAAM,EAAC,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAQpD;;;;GAIG;AACH,qBAAa,IAAI;IACf,mCAAmC;IACnC,MAAM,CAAC,KAAK,EAAE,YAAY,CAAa;IAEvC,iBAAiB;IACjB,MAAM,CAAC,GAAG,EAAE,GAAG,CAAO;IAEtB,MAAM,CAAC,eAAe,CAAC,aAAa,EAAE,GAAG,EAAE,GAAyB,IAAI;IAOxE,MAAM,CAAC,mBAAmB,IAAI,MAAM,EAAE;IAKtC,MAAM,CAAC,mBAAmB,IAAI,MAAM,EAAE;IAKtC,MAAM,CAAC,qBAAqB,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAItD,wCAAwC;WAC3B,YAAY,CAAC,KAAK,GAAE,WAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;CAiCpE"}

package/dist/lib/luma.js

@@ -1,63 +1,68 @@
-import { Device } from "../adapter/device.js";
-import { lumaStats } from "../utils/stats-manager.js";
-import { log } from "../utils/log.js";
-import { assert } from "../utils/assert.js";
+// luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+import { Device } from '../adapter/device';
+import { lumaStats } from '../utils/stats-manager';
+import { log } from '../utils/log';
+import { assert } from '../utils/assert';
 const deviceList = new Map();
+/**
+ * Entry point to the luma.gl GPU abstraction
+ * Register WebGPU and/or WebGL devices (controls application bundle size)
+ * Run-time selection of the first available Device
+ */
 export class luma {
-  static registerDevices(deviceClasses) {
-    for (const deviceClass of deviceClasses) {
-      assert(deviceClass.type && deviceClass.isSupported && deviceClass.create);
-      deviceList.set(deviceClass.type, deviceClass);
+    /** Global stats for all devices */
+    static stats = lumaStats;
+    /** Global log */
+    static log = log;
+    static registerDevices(deviceClasses /* : typeof Device */) {
+        for (const deviceClass of deviceClasses) {
+            assert(deviceClass.type && deviceClass.isSupported && deviceClass.create);
+            deviceList.set(deviceClass.type, deviceClass);
+        }
     }
-  }
-  static getAvailableDevices() {
-    return Array.from(deviceList).map(Device => Device.type);
-  }
-  static getSupportedDevices() {
-    return Array.from(deviceList).filter(Device => Device.isSupported()).map(Device => Device.type);
-  }
-  static setDefaultDeviceProps(props) {
-    Object.assign(Device.defaultProps, props);
-  }
-  static async createDevice() {
-    let props = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    props = {
-      ...Device.defaultProps,
-      ...props
-    };
-    if (props.gl) {
-      props.type = 'webgl';
+    static getAvailableDevices() {
+        // @ts-expect-error
+        return Array.from(deviceList).map(Device => Device.type);
     }
-    let DeviceClass;
-    switch (props.type) {
-      case 'webgpu':
-        DeviceClass = deviceList.get('webgpu');
-        if (DeviceClass) {
-          return await DeviceClass.create(props);
-        }
-        break;
-      case 'webgl':
-      case 'webgl1':
-      case 'webgl2':
-        DeviceClass = deviceList.get('webgl');
-        if (DeviceClass) {
-          return await DeviceClass.create(props);
-        }
-        break;
-      case 'best-available':
-        DeviceClass = deviceList.get('webgpu');
-        if (DeviceClass && DeviceClass.isSupported()) {
-          return await DeviceClass.create(props);
+    static getSupportedDevices() {
+        // @ts-expect-error
+        return Array.from(deviceList).filter(Device => Device.isSupported()).map(Device => Device.type);
+    }
+    static setDefaultDeviceProps(props) {
+        Object.assign(Device.defaultProps, props);
+    }
+    /** Creates a device. Asynchronously. */
+    static async createDevice(props = {}) {
+        props = { ...Device.defaultProps, ...props };
+        if (props.gl) {
+            props.type = 'webgl';
         }
-        DeviceClass = deviceList.get('webgl');
-        if (DeviceClass && DeviceClass.isSupported()) {
-          return await DeviceClass.create(props);
+        let DeviceClass;
+        switch (props.type) {
+            case 'webgpu':
+                DeviceClass = deviceList.get('webgpu');
+                if (DeviceClass) {
+                    return await DeviceClass.create(props);
+                }
+                break;
+            case 'webgl':
+                DeviceClass = deviceList.get('webgl');
+                if (DeviceClass) {
+                    return await DeviceClass.create(props);
+                }
+                break;
+            case 'best-available':
+                DeviceClass = deviceList.get('webgpu');
+                if (DeviceClass && DeviceClass.isSupported()) {
+                    return await DeviceClass.create(props);
+                }
+                DeviceClass = deviceList.get('webgl');
+                if (DeviceClass && DeviceClass.isSupported()) {
+                    return await DeviceClass.create(props);
+                }
+                break;
         }
-        break;
+        throw new Error('No matching device found. Ensure `@luma.gl/webgl` and/or `@luma.gl/webgpu` modules are imported.');
     }
-    throw new Error('No matching device found. Ensure `@luma.gl/webgl` and/or `@luma.gl/webgpu` modules are imported.');
-  }
 }
-luma.stats = lumaStats;
-luma.log = log;
-//# sourceMappingURL=luma.js.map

package/dist/lib/uniforms/uniform-block.d.ts

@@ -4,7 +4,6 @@ import { ShaderLayout, UniformInfo } from '../../adapter/types/shader-layout';
 /**
  * A uniform block holds values of the of uniform values for one uniform block / buffer.
  * It also does some book keeping on what has changed, to minimize unnecessary writes to uniform buffers.
- * @todo - Track changes to individual uniforms (for WebGL1)
  */
 export declare class UniformBlock<TUniforms extends Record<string, UniformValue> = Record<string, UniformValue>> {
     name: string;

package/dist/lib/uniforms/uniform-block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uniform-block.d.ts","sourceRoot":"","sources":["../../../src/lib/uniforms/uniform-block.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,WAAW,EAEZ,MAAM,mCAAmC,CAAC;AAG3C;;;;GAIG;AACH,qBAAa,YAAY,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IACrG,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,YAAY,CAAC,CAA+C;IAC9F,gBAAgB,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,OAAO,CAAC,CAA0C;IAC5F,QAAQ,EAAE,OAAO,CAAQ;IAEzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAM;IACzD,WAAW,EAAE,MAAM,GAAG,KAAK,CAAiB;gBAEhC,KAAK,CAAC,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;KAC3E;IAmBD,4BAA4B;IAC5B,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAS/C,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC,2BAA2B;IAC3B,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAO9C,2BAA2B;IAC3B,OAAO,CAAC,WAAW;CAQpB"}
+{"version":3,"file":"uniform-block.d.ts","sourceRoot":"","sources":["../../../src/lib/uniforms/uniform-block.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,kCAAkC,CAAC;AACxE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,YAAY,EACZ,WAAW,EAEZ,MAAM,mCAAmC,CAAC;AAG3C;;;GAGG;AACH,qBAAa,YAAY,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IACrG,IAAI,EAAE,MAAM,CAAC;IAEb,QAAQ,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,YAAY,CAAC,CAA+C;IAC9F,gBAAgB,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,OAAO,CAAC,CAA0C;IAC5F,QAAQ,EAAE,OAAO,CAAQ;IAEzB,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAM;IACzD,WAAW,EAAE,MAAM,GAAG,KAAK,CAAiB;gBAEhC,KAAK,CAAC,EAAE;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,YAAY,CAAC;QAC5B,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;KAC3E;IAmBD,4BAA4B;IAC5B,WAAW,CAAC,QAAQ,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI;IAS/C,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIpC,2BAA2B;IAC3B,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAO9C,2BAA2B;IAC3B,OAAO,CAAC,WAAW;CAQpB"}

package/dist/lib/uniforms/uniform-block.js

@@ -1,48 +1,55 @@
-import { arrayEqual, arrayCopy } from "../../utils/array-equal.js";
+import { arrayEqual, arrayCopy } from '../../utils/array-equal';
+/**
+ * A uniform block holds values of the of uniform values for one uniform block / buffer.
+ * It also does some book keeping on what has changed, to minimize unnecessary writes to uniform buffers.
+ */
 export class UniformBlock {
-  constructor(props) {
-    this.name = void 0;
-    this.uniforms = {};
-    this.modifiedUniforms = {};
-    this.modified = true;
-    this.bindingLayout = {};
-    this.needsRedraw = 'initialized';
-    this.name = props === null || props === void 0 ? void 0 : props.name;
-    if (props !== null && props !== void 0 && props.name && props !== null && props !== void 0 && props.shaderLayout) {
-      var _props$shaderLayout$b;
-      const binding = props === null || props === void 0 || (_props$shaderLayout$b = props.shaderLayout.bindings) === null || _props$shaderLayout$b === void 0 ? void 0 : _props$shaderLayout$b.find(binding => binding.type === 'uniform' && binding.name === (props === null || props === void 0 ? void 0 : props.name));
-      if (!binding) {
-        throw new Error(props === null || props === void 0 ? void 0 : props.name);
-      }
-      const uniformBlock = binding;
-      for (const uniform of uniformBlock.uniforms || []) {
-        this.bindingLayout[uniform.name] = uniform;
-      }
+    name;
+    uniforms = {};
+    modifiedUniforms = {};
+    modified = true;
+    bindingLayout = {};
+    needsRedraw = 'initialized';
+    constructor(props) {
+        this.name = props?.name;
+        // TODO - Extract uniform layout from the shaderLayout object
+        if (props?.name && props?.shaderLayout) {
+            const binding = props?.shaderLayout.bindings?.find(binding => binding.type === 'uniform' && binding.name === props?.name);
+            if (!binding) {
+                throw new Error(props?.name);
+            }
+            const uniformBlock = binding;
+            for (const uniform of uniformBlock.uniforms || []) {
+                this.bindingLayout[uniform.name] = uniform;
+            }
+        }
     }
-  }
-  setUniforms(uniforms) {
-    for (const [key, value] of Object.entries(uniforms)) {
-      this._setUniform(key, value);
-      if (!this.needsRedraw) {
-        this.setNeedsRedraw(`${this.name}.${key}=${value}`);
-      }
+    /** Set a map of uniforms */
+    setUniforms(uniforms) {
+        for (const [key, value] of Object.entries(uniforms)) {
+            this._setUniform(key, value);
+            if (!this.needsRedraw) {
+                this.setNeedsRedraw(`${this.name}.${key}=${value}`);
+            }
+        }
     }
-  }
-  setNeedsRedraw(reason) {
-    this.needsRedraw = this.needsRedraw || reason;
-  }
-  getAllUniforms() {
-    this.modifiedUniforms = {};
-    this.needsRedraw = false;
-    return this.uniforms || {};
-  }
-  _setUniform(key, value) {
-    if (arrayEqual(this.uniforms[key], value)) {
-      return;
+    setNeedsRedraw(reason) {
+        this.needsRedraw = this.needsRedraw || reason;
+    }
+    /** Returns all uniforms */
+    getAllUniforms() {
+        // @ts-expect-error
+        this.modifiedUniforms = {};
+        this.needsRedraw = false;
+        return (this.uniforms || {});
+    }
+    /** Set a single uniform */
+    _setUniform(key, value) {
+        if (arrayEqual(this.uniforms[key], value)) {
+            return;
+        }
+        this.uniforms[key] = arrayCopy(value);
+        this.modifiedUniforms[key] = true;
+        this.modified = true;
     }
-    this.uniforms[key] = arrayCopy(value);
-    this.modifiedUniforms[key] = true;
-    this.modified = true;
-  }
 }
-//# sourceMappingURL=uniform-block.js.map

package/dist/lib/uniforms/uniform-buffer-layout.js

@@ -1,76 +1,93 @@
-import { decodeShaderUniformType, alignTo } from "../../adapter/type-utils/decode-shader-types.js";
-import { getScratchArrayBuffer } from "../../utils/array-utils-flat.js";
-import { isNumberArray } from "../../utils/is-array.js";
-import { log } from "../../utils/log.js";
+import { decodeShaderUniformType, alignTo } from '../../adapter/type-utils/decode-shader-types';
+import { getScratchArrayBuffer } from '../../utils/array-utils-flat';
+import { isNumberArray } from '../../utils/is-array';
+import { log } from '../../utils/log';
+/**
+ * Smallest buffer size that can be used for uniform buffers.
+ * TODO - does this depend on device?
+ */
 const minBufferSize = 1024;
+/**
+ * Std140 layout for uniform buffers
+ * Supports manual listing of uniforms
+ */
 export class UniformBufferLayout {
-  constructor(uniformTypes) {
-    this.layout = {};
-    this.byteLength = void 0;
-    let size = 0;
-    for (const [key, uniformType] of Object.entries(uniformTypes)) {
-      const typeAndComponents = decodeShaderUniformType(uniformType);
-      const {
-        type,
-        components: count
-      } = typeAndComponents;
-      size = alignTo(size, count);
-      const offset = size;
-      size += count;
-      this.layout[key] = {
-        type,
-        size: count,
-        offset
-      };
-    }
-    size += (4 - size % 4) % 4;
-    const actualByteLength = size * 4;
-    this.byteLength = Math.max(actualByteLength, minBufferSize);
-  }
-  getData(uniformValues) {
-    const bufferSize = Math.max(this.byteLength, minBufferSize);
-    const arrayBuffer = getScratchArrayBuffer(bufferSize);
-    const typedArrays = {
-      i32: new Int32Array(arrayBuffer),
-      u32: new Uint32Array(arrayBuffer),
-      f32: new Float32Array(arrayBuffer),
-      f16: new Uint16Array(arrayBuffer)
-    };
-    for (const [name, value] of Object.entries(uniformValues)) {
-      const uniformLayout = this.layout[name];
-      if (!uniformLayout) {
-        log.warn(`Supplied uniform value ${name} not present in uniform block layout`)();
-        continue;
-      }
-      const {
-        type,
-        size,
-        offset
-      } = uniformLayout;
-      const typedArray = typedArrays[type];
-      if (size === 1) {
-        if (typeof value !== 'number' && typeof value !== 'boolean') {
-          log.warn(`Supplied value for single component uniform ${name} is not a number: ${value}`)();
-          continue;
+    layout = {};
+    /** number of bytes needed for buffer allocation */
+    byteLength;
+    /** Create a new UniformBufferLayout given a map of attributes. */
+    constructor(uniformTypes) {
+        /** number of 4 byte slots taken */
+        let size = 0;
+        // Add layout (type, size and offset) definitions for each uniform in the layout
+        for (const [key, uniformType] of Object.entries(uniformTypes)) {
+            const typeAndComponents = decodeShaderUniformType(uniformType);
+            const { type, components: count } = typeAndComponents;
+            // First, align (bump) current offset to an even multiple of current object (1, 2, 4)
+            size = alignTo(size, count);
+            // Use the aligned size as the offset of the current uniform.
+            const offset = size;
+            // Then, add our object's padded size ((1, 2, multiple of 4) to the current offset
+            size += count;
+            this.layout[key] = { type, size: count, offset };
         }
-        typedArray[offset] = Number(value);
-      } else {
-        const numericArray = isNumberArray(value);
-        if (!numericArray) {
-          log.warn(`Supplied value for multi component / array uniform ${name} is not a numeric array: ${value}`)();
-          continue;
+        size += (4 - (size % 4)) % 4;
+        const actualByteLength = size * 4;
+        this.byteLength = Math.max(actualByteLength, minBufferSize);
+    }
+    /** Get the data for the complete buffer */
+    getData(uniformValues) {
+        const bufferSize = Math.max(this.byteLength, minBufferSize);
+        // Allocate three typed arrays pointing at same memory
+        const arrayBuffer = getScratchArrayBuffer(bufferSize);
+        const typedArrays = {
+            i32: new Int32Array(arrayBuffer),
+            u32: new Uint32Array(arrayBuffer),
+            f32: new Float32Array(arrayBuffer),
+            // TODO not implemented
+            f16: new Uint16Array(arrayBuffer)
+        };
+        // TODO is this needed?
+        // typedArrays.i32.fill(0);
+        for (const [name, value] of Object.entries(uniformValues)) {
+            const uniformLayout = this.layout[name];
+            if (!uniformLayout) {
+                log.warn(`Supplied uniform value ${name} not present in uniform block layout`)();
+                // eslint-disable-next-line no-continue
+                continue;
+            }
+            const { type, size, offset } = uniformLayout;
+            const typedArray = typedArrays[type];
+            if (size === 1) {
+                if (typeof value !== 'number' && typeof value !== 'boolean') {
+                    log.warn(`Supplied value for single component uniform ${name} is not a number: ${value}`)();
+                    // eslint-disable-next-line no-continue
+                    continue;
+                }
+                // single value -> just set it
+                typedArray[offset] = Number(value);
+            }
+            else {
+                const numericArray = isNumberArray(value);
+                if (!numericArray) {
+                    log.warn(`Supplied value for multi component / array uniform ${name} is not a numeric array: ${value}`)();
+                    // eslint-disable-next-line no-continue
+                    continue;
+                }
+                // vector/matrix -> copy the supplied (typed) array, starting from offset
+                // TODO: we should limit or check size in case the supplied data overflows
+                typedArray.set(numericArray, offset);
+            }
         }
-        typedArray.set(numericArray, offset);
-      }
+        return new Uint8Array(arrayBuffer);
+    }
+    /** Does this layout have a field with specified name */
+    has(name) {
+        return Boolean(this.layout[name]);
+    }
+    /** Get offset and size for a field with specified name */
+    get(name) {
+        const layout = this.layout[name];
+        return layout;
     }
-    return new Uint8Array(arrayBuffer);
-  }
-  has(name) {
-    return Boolean(this.layout[name]);
-  }
-  get(name) {
-    const layout = this.layout[name];
-    return layout;
-  }
 }
-//# sourceMappingURL=uniform-buffer-layout.js.map