@luma.gl/webgl 8.5.10 → 8.6.0-alpha.1

package/{dist/es5/index.d.ts → src/index.ts}

@@ -22,20 +22,15 @@ export {default as canCompileGLGSExtension} from './features/check-glsl-extensio
 export {default as Accessor} from './classes/accessor';
 
 // WebGL1 classes
-export {default as Buffer, BufferProps} from './classes/buffer';
-export {default as Framebuffer} from './classes/framebuffer';
-export {default as Renderbuffer} from './classes/renderbuffer';
-export {default as Query} from './classes/query';
-export {Shader, VertexShader, FragmentShader, ShaderProps} from './classes/shader';
-export {default as Program, ProgramProps} from './classes/program';
+// export type {BufferProps} from './api/buffer';
+export {default as Buffer} from './classes/webgl-buffer';
 export {default as Texture2D, Texture2DProps} from './classes/texture-2d';
 export {default as TextureCube, TextureCubeProps} from './classes/texture-cube';
-export {default as Texture3D, Texture3DProps} from './classes/texture-3d';
-export {default as TransformFeedback, TransformFeedbackProps} from './classes/transform-feedback';
-export {default as VertexArrayObject, VertexArrayObjectProps} from './classes/vertex-array-object';
-export {default as VertexArray, VertexArrayProps} from './classes/vertex-array';
 
-export {default as UniformBufferLayout} from './classes/uniform-buffer-layout';
+export {Shader, VertexShader, FragmentShader, ShaderProps} from './classes/webgl-shader';
+export {default as Program, ProgramProps} from './classes/program';
+export {default as Framebuffer, FramebufferProps} from './classes/framebuffer';
+export {default as Renderbuffer, RenderbufferProps} from './classes/renderbuffer';
 
 export {clear, clearBuffer} from './classes/clear';
 
@@ -50,18 +45,20 @@ export {
 } from './classes/copy-and-blit';
 
 // WebGL2 classes & Extensions
+export {default as Query, QueryProps} from './classes/query';
+export {default as Texture3D, Texture3DProps} from './classes/texture-3d';
+export {default as TransformFeedback, TransformFeedbackProps} from './classes/transform-feedback';
+export {default as VertexArrayObject, VertexArrayObjectProps} from './classes/vertex-array-object';
+export {default as VertexArray, VertexArrayProps} from './classes/vertex-array';
+export {default as UniformBufferLayout} from './classes/uniform-buffer-layout';
 
 // experimental WebGL exports
 
 export {setPathPrefix, loadFile, loadImage} from './utils/load-file';
 
-// PARSE SHADER SOURCE
-export {default as getShaderName} from './glsl-utils/get-shader-name';
-export {default as getShaderVersion} from './glsl-utils/get-shader-version';
-
 // UTILS
 export {log} from '@luma.gl/gltools';
-export {assert} from './utils/assert';
+export {default as assert} from './utils/assert';
 export {uid, isObjectEmpty} from './utils/utils';
 
 // INTERNAL
@@ -69,3 +66,8 @@ export {parseUniformName, getUniformSetter} from './classes/uniforms';
 export {getDebugTableForUniforms} from './debug/debug-uniforms';
 export {getDebugTableForVertexArray} from './debug/debug-vertex-array';
 export {getDebugTableForProgramConfiguration} from './debug/debug-program-configuration';
+
+// REMOVED in v8.6
+// getShaderInfo,
+// getShaderName
+// getShaderVersion

package/src/{init.js → init.ts}

@@ -1,9 +1,8 @@
 import {log} from '@luma.gl/gltools';
-import {Stats} from 'probe.gl';
 import {isBrowser, global} from 'probe.gl/env';
+import {lumaStats} from '@luma.gl/api';
 
 // Version detection using babel plugin
-/* global __VERSION__ */
 // @ts-ignore
 const VERSION = typeof __VERSION__ !== 'undefined' ? __VERSION__ : 'untranspiled source';
 
@@ -12,22 +11,6 @@ const STARTUP_MESSAGE = 'set luma.log.level=1 (or higher) to trace rendering';
 // 0: none, 1: minimal, 2: verbose, 3: attribute/uniforms, 4: gl logs
 // luma.log.break[], set to gl funcs, luma.log.profile[] set to model names`;
 
-class StatsManager {
-  constructor() {
-    this.stats = new Map();
-  }
-
-  get(name) {
-    if (!this.stats.has(name)) {
-      this.stats.set(name, new Stats({id: name}));
-    }
-
-    return this.stats.get(name);
-  }
-}
-
-const lumaStats = new StatsManager();
-
 if (global.luma && global.luma.VERSION !== VERSION) {
   throw new Error(`luma.gl - multiple VERSIONs detected: ${global.luma.VERSION} vs ${VERSION}`);
 }

package/src/utils/{assert.js → assert.ts}

@@ -1,6 +1,6 @@
 // Recommendation is to ignore message but current test suite checks agains the
 // message so keep it for now.
-export function assert(condition, message) {
+export default function assert(condition, message?: string): void {
   if (!condition) {
     throw new Error(message || 'luma.gl: assertion failed.');
   }

package/src/utils/{format-value.js → format-value.ts}

@@ -13,9 +13,9 @@ function formatArrayValue(v, opts) {
   return `${string}${terminator}`;
 }
 
-export function formatValue(v, opts = {}) {
+export function formatValue(v, opts?: {isInteger?: boolean, size?: number}) {
   const EPSILON = 1e-16;
-  const {isInteger = false} = opts;
+  const {isInteger = false} = opts || {};
   if (Array.isArray(v) || ArrayBuffer.isView(v)) {
     return formatArrayValue(v, opts);
   }

package/src/utils/index.ts

@@ -0,0 +1,6 @@
+export {default as assert} from './assert';
+export {default as isOldIE} from './is-old-ie';
+export {uid, isPowerOfTwo, isObjectEmpty} from './utils';
+export {formatValue} from './format-value';
+export {stubRemovedMethods} from './stub-methods';
+export {checkProps} from './check-props';

package/src/utils/{is-old-ie.js → is-old-ie.ts}

@@ -1,6 +1,6 @@
 import {getBrowser} from 'probe.gl/env';
 
 // opts allows user agent to be overridden for testing
-export function isOldIE(opts = {}) {
+export default function isOldIE(opts: {userAgent?}): boolean {
   return getBrowser(opts.userAgent) === 'IE';
 }

package/src/utils/{load-file.js → load-file.ts}

@@ -1,4 +1,4 @@
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
 
 let pathPrefix = '';
 
@@ -13,8 +13,9 @@ export function setPathPrefix(prefix) {
 export function loadFile(url, options = {}) {
   assert(typeof url === 'string');
   url = pathPrefix + url;
+  // @ts-expect-error
   const dataType = options.dataType || 'text';
-  return fetch(url, options).then(res => res[dataType]());
+  return fetch(url, options).then((res) => res[dataType]());
 }
 
 /*

package/src/utils/{stub-methods.js → stub-methods.ts}

@@ -7,7 +7,7 @@ https://luma.gl/docs/upgrade-guide`;
 
   const prototype = Object.getPrototypeOf(instance);
 
-  methodNames.forEach(methodName => {
+  methodNames.forEach((methodName) => {
     if (prototype.methodName) {
       return;
     }

package/src/utils/utils.ts

@@ -0,0 +1,35 @@
+import assert from './assert';
+
+const uidCounters = {};
+
+/**
+ * Returns a UID.
+ * @param id= - Identifier base name
+ * @return uid
+ **/
+export function uid(id: string = 'id'): string {
+  uidCounters[id] = uidCounters[id] || 1;
+  const count = uidCounters[id]++;
+  return `${id}-${count}`;
+}
+
+/**
+ * Verifies if a given number is power of two or not.
+ * @param n - The number to check.
+ * @return  Returns true if the given number is power of 2, false otherwise.
+ **/
+export function isPowerOfTwo(n: number): boolean {
+  return n && (n & (n - 1)) === 0;
+}
+
+/** Returns true if given object is empty, false otherwise. */
+export function isObjectEmpty(obj: object): boolean {
+  let isEmpty = true;
+  /* eslint-disable no-unused-vars  */
+  for (const key in obj) {
+    isEmpty = false;
+    break;
+  }
+  /* eslint-enable no-unused-vars  */
+  return isEmpty;
+}

package/src/webgl-utils/{attribute-utils.js → attribute-utils.ts}

@@ -1,5 +1,4 @@
-/* eslint-disable camelcase */
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
 
 const GL_BYTE = 0x1400;
 const GL_UNSIGNED_BYTE = 0x1401;

package/src/webgl-utils/{constants-to-keys.js → constants-to-keys.ts}

@@ -1,4 +1,4 @@
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
 
 // Resolve a WebGL enumeration name (returns itself if already a number)
 export function getKeyValue(gl, name) {

package/src/webgl-utils/{format-utils.js → format-utils.ts}

@@ -1,5 +1,5 @@
 import GL from '@luma.gl/constants';
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
 
 // Returns number of components in a specific readPixels WebGL format
 export function glFormatToComponents(format) {

package/src/webgl-utils/index.ts

@@ -0,0 +1,12 @@
+export {requestAnimationFrame, cancelAnimationFrame} from './request-animation-frame';
+
+export {
+  getGLTypeFromTypedArray,
+  getTypedArrayFromGLType,
+  flipRows,
+  scalePixels
+} from './typed-array-utils';
+
+export {getKeyValue, getKey, getKeyType} from './constants-to-keys';
+
+export {cloneTextureFrom} from './texture-utils';

package/src/webgl-utils/parse-shader-compiler-log.ts

@@ -0,0 +1,48 @@
+// luma.gl, MIT license
+import type {CompilerMessage} from '@luma.gl/shadertools';
+
+const MESSAGE_TYPES = ['warning', 'error', 'info'];
+
+/**
+ * Parse a WebGL-format GLSL compilation log into an array of WebGPU style message records.
+ * This follows documented WebGL conventions for compilation logs.
+ * Based on https://github.com/wwwtyro/gl-format-compiler-error (public domain)
+ */
+export function parseShaderCompilerLog(errLog: string) : readonly CompilerMessage[] {
+  // Parse the error - note: browser and driver dependent
+  const lines = errLog.split(/\r?\n/);
+
+  const messages: CompilerMessage[] = [];
+
+  for (const line of lines) {
+    if (line.length <= 1) {
+      continue;
+    }
+
+    const segments: string[] = line.split(':');
+    const [messageType, linePosition, lineNumber, ...rest] = segments;
+
+    let lineNum = parseInt(lineNumber, 10);
+    if (isNaN(lineNum)) {
+      lineNum = 0;
+    }
+
+    let linePos = parseInt(linePosition, 10);
+    if (isNaN(linePos)) {
+      linePos = 0;
+    }
+
+    // Ensure supported type
+    const lowerCaseType = messageType.toLowerCase();
+    const type = (MESSAGE_TYPES.includes(lowerCaseType) ? lowerCaseType : 'info') as 'warning' | 'error' | 'info';
+
+    messages.push({
+      message: rest.join(':').trim(),
+      type,
+      lineNum,
+      linePos // TODO
+    })
+  }
+
+  return messages;
+}

package/src/webgl-utils/{request-animation-frame.js → request-animation-frame.ts}

@@ -1,12 +1,13 @@
 // Node.js polyfills for requestAnimationFrame and cancelAnimationFrame
+// / <reference types="@types/node" />
 
-export function requestAnimationFrame(callback) {
+export function requestAnimationFrame(callback): number | NodeJS.Timeout {
   return typeof window !== 'undefined' && window.requestAnimationFrame
     ? window.requestAnimationFrame(callback)
     : setTimeout(callback, 1000 / 60);
 }
 
-export function cancelAnimationFrame(timerId) {
+export function cancelAnimationFrame(timerId): void {
   return typeof window !== 'undefined' && window.cancelAnimationFrame
     ? window.cancelAnimationFrame(timerId)
     : clearTimeout(timerId);

package/src/webgl-utils/texture-utils.js

@@ -4,7 +4,7 @@ import TextureCube from '../classes/texture-cube';
 import Texture3D from '../classes/texture-3d';
 import Framebuffer from '../classes/framebuffer';
 import GL from '@luma.gl/constants';
-import {assert} from '../utils/assert';
+import {assert} from '../utils';
 
 // Clone a new texture object from a reference texture object.
 /** @type {import('./texture-utils').cloneTextureFrom} */
@@ -33,6 +33,7 @@ export function cloneTextureFrom(refTexture, overrides) {
   );
 
   // TODO: move this to `Texture` class as instance method and use this.constructor
+  // @ts-expect-error
   return new TextureType(gl, textureOptions);
 }