@luma.gl/webgl 8.5.9 → 8.6.0-alpha.3

package/src/glsl-utils/format-glsl-error.js

@@ -1,107 +0,0 @@
-// TODO - formatGLSLCompilerError should not depend on this
-import getShaderName from './get-shader-name';
-import getShaderTypeName from './get-shader-type-name';
-
-// Formats GLSL compiler error log into single string
-export default function formatGLSLCompilerError(errLog, src, shaderType) {
-  const {shaderName, errors, warnings} = parseGLSLCompilerError(errLog, src, shaderType);
-  return `GLSL compilation error in ${shaderName}\n\n${errors}\n${warnings}`;
-}
-
-/**
- * Parse a GLSL compiler error log into a string showing the source code around each error.
- * Based on https://github.com/wwwtyro/gl-format-compiler-error (public domain)
- */
-/* eslint-disable no-continue, max-statements */
-export function parseGLSLCompilerError(errLog, src, shaderType, shaderName) {
-  const errorStrings = errLog.split(/\r?\n/);
-  const errors = {};
-  const warnings = {};
-
-  // Patch the shader name
-  const name = shaderName || getShaderName(src) || '(unnamed)';
-  const shaderDescription = `${getShaderTypeName(shaderType)} shader ${name}`;
-
-  // Parse the error - note: browser and driver dependent
-  for (let i = 0; i < errorStrings.length; i++) {
-    const errorString = errorStrings[i];
-    if (errorString.length <= 1) {
-      continue;
-    }
-    const segments = errorString.split(':');
-    const type = segments[0];
-    const line = parseInt(segments[2], 10);
-    if (isNaN(line)) {
-      throw new Error(`GLSL compilation error in ${shaderDescription}: ${errLog}`);
-    }
-    if (type !== 'WARNING') {
-      errors[line] = errorString;
-    } else {
-      warnings[line] = errorString;
-    }
-  }
-
-  // Format the error inline with the code
-  const lines = addLineNumbers(src);
-
-  return {
-    shaderName: shaderDescription,
-    errors: formatErrors(errors, lines),
-    warnings: formatErrors(warnings, lines)
-  };
-}
-
-// helper function, outputs annotated errors or warnings
-function formatErrors(errors, lines) {
-  let message = '';
-  for (let i = 0; i < lines.length; i++) {
-    const line = lines[i];
-    if (!errors[i + 3] && !errors[i + 2] && !errors[i + 1]) {
-      continue;
-    }
-    message += `${line}\n`;
-    if (errors[i + 1]) {
-      const error = errors[i + 1];
-      const segments = error.split(':', 3);
-      const type = segments[0];
-      const column = parseInt(segments[1], 10) || 0;
-      const err = error.substring(segments.join(':').length + 1).trim();
-      message += padLeft(`^^^ ${type}: ${err}\n\n`, column);
-    }
-  }
-  return message;
-}
-
-/**
- * Prepends line numbers to each line of a string.
- * The line numbers will be left-padded with spaces to ensure an
- * aligned layout when rendered using monospace fonts.
- * @param {String} string - multi-line string to add line numbers to
- * @param {Number} start=1 - number of spaces to add
- * @param {String} delim =': ' - injected between line number and original line
- * @return {String[]} strings - array of string, one per line, with line numbers added
- */
-function addLineNumbers(string, start = 1, delim = ': ') {
-  const lines = string.split(/\r?\n/);
-  const maxDigits = String(lines.length + start - 1).length;
-  return lines.map((line, i) => {
-    const lineNumber = String(i + start);
-    const digits = lineNumber.length;
-    const prefix = padLeft(lineNumber, maxDigits - digits);
-    return prefix + delim + line;
-  });
-}
-
-/**
- * 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, digits) {
-  let result = '';
-  for (let i = 0; i < digits; ++i) {
-    result += ' ';
-  }
-  return `${result}${string}`;
-}

package/src/glsl-utils/get-shader-name.js

@@ -1,7 +0,0 @@
-// Supports GLSLIFY style naming of shaders
-// #define SHADER_NAME ...
-export default function getShaderName(shader, defaultName = 'unnamed') {
-  const SHADER_NAME_REGEXP = /#define[\s*]SHADER_NAME[\s*]([A-Za-z0-9_-]+)[\s*]/;
-  const match = shader.match(SHADER_NAME_REGEXP);
-  return match ? match[1] : defaultName;
-}

package/src/glsl-utils/get-shader-type-name.js

@@ -1,13 +0,0 @@
-const GL_FRAGMENT_SHADER = 0x8b30;
-const GL_VERTEX_SHADER = 0x8b31;
-
-export default function getShaderTypeName(type) {
-  switch (type) {
-    case GL_FRAGMENT_SHADER:
-      return 'fragment';
-    case GL_VERTEX_SHADER:
-      return 'vertex';
-    default:
-      return 'unknown type';
-  }
-}

package/src/glsl-utils/get-shader-version.js

@@ -1,12 +0,0 @@
-// returns GLSL shader version of given shader string
-export default function getShaderVersion(source) {
-  let version = 100;
-  const words = source.match(/[^\s]+/g);
-  if (words.length >= 2 && words[0] === '#version') {
-    const v = parseInt(words[1], 10);
-    if (Number.isFinite(v)) {
-      version = v;
-    }
-  }
-  return version;
-}

package/src/glsl-utils/index.js

@@ -1,8 +0,0 @@
-// PARSE SHADER ERRORS
-export {default as formatGLSLCompilerError, parseGLSLCompilerError} from './format-glsl-error';
-
-// PARSE SHADER SOURCE
-export {default as getShaderName} from './get-shader-name';
-export {default as getShaderVersion} from './get-shader-version';
-
-export {default as getShaderTypeName} from './get-shader-type-name';

package/src/index.d.ts

@@ -1,71 +0,0 @@
-// luma.gl Base WebGL wrapper library
-// Provides simple class/function wrappers around the low level webgl objects
-// These classes are intentionally close to the WebGL API
-// but make it easier to use.
-// Higher level abstractions can be built on these classes
-
-// Initialize any global state
-export {lumaStats} from './init';
-
-// UTILS
-export {requestAnimationFrame, cancelAnimationFrame} from './webgl-utils/request-animation-frame';
-
-// WebGL Functions
-export {cloneTextureFrom} from './webgl-utils/texture-utils';
-export {getKeyValue, getKey} from './webgl-utils/constants-to-keys';
-export {getContextInfo, getGLContextInfo, getContextLimits} from './features/limits';
-export {FEATURES} from './features/webgl-features-table';
-export {hasFeature, hasFeatures, getFeatures} from './features/features';
-export {default as canCompileGLGSExtension} from './features/check-glsl-extension';
-
-// WebGL Helper Classes
-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 {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 {clear, clearBuffer} from './classes/clear';
-
-// Copy and Blit
-export {
-  readPixelsToArray,
-  readPixelsToBuffer,
-  copyToDataUrl,
-  copyToImage,
-  copyToTexture,
-  blit
-} from './classes/copy-and-blit';
-
-// WebGL2 classes & Extensions
-
-// 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 {uid, isObjectEmpty} from './utils/utils';
-
-// INTERNAL
-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';

package/src/index.js

@@ -1,70 +0,0 @@
-// luma.gl Base WebGL wrapper library
-// Provides simple class/function wrappers around the low level webgl objects
-// These classes are intentionally close to the WebGL API
-// but make it easier to use.
-// Higher level abstractions can be built on these classes
-
-// Initialize any global state
-export {lumaStats} from './init';
-
-// UTILS
-export {requestAnimationFrame, cancelAnimationFrame} from './webgl-utils/request-animation-frame';
-
-// WebGL Functions
-export {cloneTextureFrom} from './webgl-utils/texture-utils';
-export {getKeyValue, getKey} from './webgl-utils/constants-to-keys';
-export {getContextInfo, getGLContextInfo, getContextLimits} from './features/limits';
-export {FEATURES} from './features/webgl-features-table';
-export {hasFeature, hasFeatures, getFeatures} from './features/features';
-export {default as canCompileGLGSExtension} from './features/check-glsl-extension';
-
-// WebGL Helper Classes
-export {default as Accessor} from './classes/accessor';
-
-// WebGL1 classes
-export {default as Buffer} from './classes/buffer';
-export {Shader, VertexShader, FragmentShader} from './classes/shader';
-export {default as Program} from './classes/program';
-export {default as Framebuffer} from './classes/framebuffer';
-export {default as Renderbuffer} from './classes/renderbuffer';
-export {default as Texture2D} from './classes/texture-2d';
-export {default as TextureCube} from './classes/texture-cube';
-
-export {clear, clearBuffer} from './classes/clear';
-
-// Copy and Blit
-export {
-  readPixelsToArray,
-  readPixelsToBuffer,
-  copyToDataUrl,
-  copyToImage,
-  copyToTexture,
-  blit
-} from './classes/copy-and-blit';
-
-// WebGL2 classes & Extensions
-export {default as Query} from './classes/query';
-export {default as Texture3D} from './classes/texture-3d';
-export {default as TransformFeedback} from './classes/transform-feedback';
-export {default as VertexArrayObject} from './classes/vertex-array-object';
-export {default as VertexArray} 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 {uid, isObjectEmpty} from './utils/utils';
-
-// INTERNAL
-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';

package/src/init.d.ts

@@ -1,12 +0,0 @@
-import {Stats} from 'probe.gl';
-
-export class StatsManager {
-  constructor();
-  get(name: any): Stats; // TODO: Isn't this get(name: string): Stats;
-}
-
-export const lumaStats: StatsManager;
-
-// luma global object - TODO - add types
-declare const _default: any;
-export default _default;

package/src/utils/array-utils-flat.js

@@ -1,56 +0,0 @@
-let arrayBuffer = null;
-
-export function getScratchArrayBuffer(byteLength) {
-  if (!arrayBuffer || arrayBuffer.byteLength < byteLength) {
-    arrayBuffer = new ArrayBuffer(byteLength);
-  }
-  return arrayBuffer;
-}
-
-export function getScratchArray(Type, length) {
-  const scratchArrayBuffer = getScratchArrayBuffer(Type.BYTES_PER_ELEMENT * length);
-  return new Type(scratchArrayBuffer, 0, length); // arrayBuffer, byteOffset, length (in elements)
-}
-
-// Uses copyWithin to significantly speed up typed array value filling
-export function fillArray({target, source, start = 0, count = 1}) {
-  const length = source.length;
-  const total = count * length;
-  let copied = 0;
-  for (let i = start; copied < length; copied++) {
-    target[i++] = source[copied];
-  }
-
-  while (copied < total) {
-    // If we have copied less than half, copy everything we got
-    // else copy remaining in one operation
-    if (copied < total - copied) {
-      target.copyWithin(start + copied, start, start + copied);
-      copied *= 2;
-    } else {
-      target.copyWithin(start + copied, start, start + total - copied);
-      copied = total;
-    }
-  }
-
-  return target;
-}
-
-/*
-
-// Creates a new Uint8Array based on two different ArrayBuffers
-// @private
-// @param {ArrayBuffers} buffer1 The first buffer.
-// @param {ArrayBuffers} buffer2 The second buffer.
-// @return {ArrayBuffers} The new ArrayBuffer created out of the two.
-//
-export function copyArrayBuffer(
-  targetBuffer, sourceBuffer, byteOffset, byteLength = sourceBuffer.byteLength
-) {
-  const targetArray = new Uint8Array(targetBuffer, byteOffset, byteLength);
-  const sourceArray = new Uint8Array(sourceBuffer);
-  targetArray.set(sourceArray);
-  return targetBuffer;
-}
-
-*/

package/src/utils/assert.d.ts

@@ -1 +0,0 @@
-export function assert(condition: any, message?: string): void;

package/src/utils/assert.js

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

package/src/utils/check-props.js

@@ -1,68 +0,0 @@
-/* Use as
-import {checkProps} from '../util/check-props;'
-
-const PROP_CHECKS = {
-  // Removed props no longer supported, print error and link to upgrade guide
-  removedProps: {
-  },
-  // Deprecated props
-  deprecatedProps: {
-    offset: 'accessor',
-    stride: 'accessor',
-    type: 'accessor',
-    size: 'accessor',
-    divisor: 'accessor',
-    normalized: 'accessor',
-    integer: 'accessor'
-  },
-  // Deprecated props that can be autosubstituted, print warning and return updated props object
-  replacedProps: {
-    bytes: 'byteLength'
-  }
-}
-
-class Buffer {
-  setProps(props) {
-    checkProps('Buffer', props, PROP_CHECKS);
-  }
-}
-*/
-import {log} from '@luma.gl/gltools';
-
-export function checkProps(className, props, propChecks) {
-  const {removedProps = {}, deprecatedProps = {}, replacedProps = {}} = propChecks;
-
-  // removedProps: Removed props no longer supported
-  // print error and link to upgrade guide
-  for (const propName in removedProps) {
-    if (propName in props) {
-      const replacementProp = removedProps[propName];
-      const replacement = replacementProp ? `${className}.${removedProps[propName]}` : 'N/A';
-      log.removed(`${className}.${propName}`, replacement)();
-    }
-  }
-
-  // deprecatedProps: Deprecated props that can not be autosubstituted
-  // print warning and rely on caller to substitute
-  for (const propName in deprecatedProps) {
-    if (propName in props) {
-      const replacementProp = deprecatedProps[propName];
-      log.deprecated(`${className}.${propName}`, `${className}.${replacementProp}`)();
-    }
-  }
-
-  // replacedProps: Deprecated props that can be autosubstituted
-  // print warning and return updated props object
-  let newProps = null;
-  for (const propName in replacedProps) {
-    if (propName in props) {
-      const replacementProp = replacedProps[propName];
-      log.deprecated(`${className}.${propName}`, `${className}.${replacementProp}`)();
-      newProps = newProps || Object.assign({}, props);
-      newProps[replacementProp] = props[propName];
-      delete newProps[propName];
-    }
-  }
-
-  return newProps || props;
-}

package/src/utils/format-value.js

@@ -1,37 +0,0 @@
-// TODO / DEPRECATED - delete when confident that probe.gl logging implements all opts
-/* eslint-disable no-console */
-function formatArrayValue(v, opts) {
-  const {maxElts = 16, size = 1} = opts;
-  let string = '[';
-  for (let i = 0; i < v.length && i < maxElts; ++i) {
-    if (i > 0) {
-      string += `,${i % size === 0 ? ' ' : ''}`;
-    }
-    string += formatValue(v[i], opts);
-  }
-  const terminator = v.length > maxElts ? '...' : ']';
-  return `${string}${terminator}`;
-}
-
-export function formatValue(v, opts = {}) {
-  const EPSILON = 1e-16;
-  const {isInteger = false} = opts;
-  if (Array.isArray(v) || ArrayBuffer.isView(v)) {
-    return formatArrayValue(v, opts);
-  }
-  if (!Number.isFinite(v)) {
-    return String(v);
-  }
-  if (Math.abs(v) < EPSILON) {
-    return isInteger ? '0' : '0.';
-  }
-  if (isInteger) {
-    return v.toFixed(0);
-  }
-  if (Math.abs(v) > 100 && Math.abs(v) < 10000) {
-    return v.toFixed(0);
-  }
-  const string = v.toPrecision(2);
-  const decimal = string.indexOf('.0');
-  return decimal === string.length - 2 ? string.slice(0, -1) : string;
-}

package/src/utils/is-old-ie.d.ts

@@ -1 +0,0 @@
-export function isOldIE(opts?: {}): boolean;

package/src/utils/is-old-ie.js

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

package/src/utils/load-file.js

@@ -1,39 +0,0 @@
-import {assert} from '../utils/assert';
-
-let pathPrefix = '';
-
-/*
- * Set a relative path prefix
- */
-export function setPathPrefix(prefix) {
-  pathPrefix = prefix;
-}
-
-// Reads raw file data from:
-export function loadFile(url, options = {}) {
-  assert(typeof url === 'string');
-  url = pathPrefix + url;
-  const dataType = options.dataType || 'text';
-  return fetch(url, options).then(res => res[dataType]());
-}
-
-/*
- * Loads images asynchronously
- * image.crossOrigin can be set via opts.crossOrigin, default to 'anonymous'
- * returns a promise tracking the load
- */
-export function loadImage(url, opts) {
-  assert(typeof url === 'string');
-  url = pathPrefix + url;
-  return new Promise((resolve, reject) => {
-    try {
-      const image = new Image();
-      image.onload = () => resolve(image);
-      image.onerror = () => reject(new Error(`Could not load image ${url}.`));
-      image.crossOrigin = (opts && opts.crossOrigin) || 'anonymous';
-      image.src = url;
-    } catch (error) {
-      reject(error);
-    }
-  });
-}

package/src/utils/stub-methods.js

@@ -1,20 +0,0 @@
-import {log} from '@luma.gl/gltools';
-
-// Install stubs for removed methods
-export function stubRemovedMethods(instance, className, version, methodNames) {
-  const upgradeMessage = `See luma.gl ${version} Upgrade Guide at \
-https://luma.gl/docs/upgrade-guide`;
-
-  const prototype = Object.getPrototypeOf(instance);
-
-  methodNames.forEach(methodName => {
-    if (prototype.methodName) {
-      return;
-    }
-
-    prototype[methodName] = () => {
-      log.removed(`Calling removed method ${className}.${methodName}: `, upgradeMessage)();
-      throw new Error(methodName);
-    };
-  });
-}

package/src/utils/utils.d.ts

@@ -1,13 +0,0 @@
-/**
- * Returns a UID.
- * @param {String} id= - Identifier base name
- * @return {number} uid
- **/
-export function uid(id?: string): string;
-/**
- * Verifies if a given number is power of two or not.
- * @param {object} n - The number to check.
- * @return {Array} Returns true if the given number is power of 2, false otherwise.
- **/
-export function isPowerOfTwo(n: any): boolean;
-export function isObjectEmpty(obj: any): boolean;

package/src/utils/utils.js

@@ -1,36 +0,0 @@
-import {assert} from './assert';
-
-const uidCounters = {};
-
-/**
- * Returns a UID.
- * @param {string} id= - Identifier base name
- * @return {string} uid
- **/
-export function uid(id = 'id') {
-  uidCounters[id] = uidCounters[id] || 1;
-  const count = uidCounters[id]++;
-  return `${id}-${count}`;
-}
-
-/**
- * Verifies if a given number is power of two or not.
- * @param {object} n - The number to check.
- * @return {boolean} Returns true if the given number is power of 2, false otherwise.
- **/
-export function isPowerOfTwo(n) {
-  assert(typeof n === 'number', 'Input must be a number');
-  return n && (n & (n - 1)) === 0;
-}
-
-// Returns true if given object is empty, false otherwise.
-export function isObjectEmpty(obj) {
-  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/request-animation-frame.d.ts

@@ -1,3 +0,0 @@
-// / <reference types="@types/node" />
-export function requestAnimationFrame(callback: any): number | NodeJS.Timeout;
-export function cancelAnimationFrame(timerId: any): void;

package/src/webgl-utils/texture-utils.d.ts

@@ -1,11 +0,0 @@
-import Texture2D from '../classes/texture-2d';
-import TextureCube from '../classes/texture-cube';
-import Texture3D from '../classes/texture-3d';
-import Texture from '../classes/texture';
-import Framebuffer, {FramebufferProps} from '../classes/framebuffer';
-
-type TextureType = Texture2D | TextureCube | Texture3D;
-
-export function cloneTextureFrom<T extends TextureType>(refTexture: T, overrides?: any): T;
-
-export function toFramebuffer(texture: Texture, opts?: FramebufferProps): Framebuffer;

package/src/webgl-utils/typed-array-utils.d.ts

@@ -1,36 +0,0 @@
-type TypedArrayConstructor =
-  | Float32ArrayConstructor
-  | Uint16ArrayConstructor
-  | Uint32ArrayConstructor
-  | Uint8ArrayConstructor
-  | Uint8ClampedArrayConstructor
-  | Int8ArrayConstructor
-  | Int16ArrayConstructor
-  | Int32ArrayConstructor;
-
-export function getGLTypeFromTypedArray(arrayOrType: any): any;
-
-export function getTypedArrayFromGLType(
-  glType: any,
-  options?: {
-    clamped?: boolean;
-  }
-): TypedArrayConstructor;
-
-export function flipRows(options: {
-  data: any;
-  width: any;
-  height: any;
-  bytesPerPixel?: number;
-  temp?: any;
-}): void;
-
-export function scalePixels(options: {
-  data: any;
-  width: any;
-  height: any;
-}): {
-  data: Uint8Array;
-  width: number;
-  height: number;
-};