@luma.gl/webgl 8.6.0-alpha.5 → 9.0.0-alpha.11

package/src/helpers/program-bindings.ts

@@ -1,46 +0,0 @@
-import {Accessor} from '../types/accessor';
-
-/** Describes an attribute binding for a program */
-export type AttributeBinding = {
-  location: number;
-  name: string;
-  accessor: Accessor;
-}
-
-/** Describes a varying binding for a program */
-export type VaryingBinding = {
-  location: number;
-  name: string;
-  accessor: Accessor;
-}
-
-/** Describes a uniform block binding for a program */
-export type UniformBlockBinding = {
-  location: number;
-  name: string;
-  byteLength: number;
-  vertex: boolean;
-  fragment: boolean;
-  uniformCount: number;
-  uniformIndices: number[];
-}
-
-/** Describes a uniform (sampler etc) binding for a program */
-export type UniformBinding = {
-  location: number;
-  name: string;
-  size: number;
-  type: number;
-  isArray: boolean;
-}
-
-/**
- * Holds metadata describing attribute configurations for a program's shaders
- */
-export type ProgramBindings = {
-  readonly attributes: AttributeBinding[];
-  readonly varyings: VaryingBinding[];
-  readonly uniformBlocks: UniformBlockBinding[];
-  // Note - samplers are always in unform bindings, even if uniform blocks are used
-  readonly uniforms: UniformBinding[];
-}

package/src/types/accessor.d.ts

@@ -1,29 +0,0 @@
-// ACCESSORS
-
-/**
- * Attribute descriptor object
- */
-export type Accessor = {
-  format?: string;
-  offset?: number;
-  location?: number;
-
-  // can now be described with single WebGPU-style `format` string
-  type?: number;
-  size?: number;
-  normalized?: boolean;
-  integer?: boolean;
-
-  // deprecated - now shared between accessors in the surrounding BufferAccessor object
-  stride?: number;
-  divisor?: number;
-};
-
-/**
- * List of attribute descriptors for one interleaved buffer
- */
-export type BufferAccessors = {
-  stride?: number;
-  stepMode?: 'vertex' | 'instance';
-  attributes: Accessor[];
-}

package/src/webgl-utils/attribute-utils.ts

@@ -1,171 +0,0 @@
-import {assert} from '@luma.gl/api';
-
-const GL_BYTE = 0x1400;
-const GL_UNSIGNED_BYTE = 0x1401;
-const GL_SHORT = 0x1402;
-const GL_UNSIGNED_SHORT = 0x1403;
-
-const GL_POINTS = 0x0;
-const GL_LINES = 0x1;
-const GL_LINE_LOOP = 0x2;
-const GL_LINE_STRIP = 0x3;
-const GL_TRIANGLES = 0x4;
-const GL_TRIANGLE_STRIP = 0x5;
-const GL_TRIANGLE_FAN = 0x6;
-
-// Local constants - these will "collapse" during minification
-const GL_FLOAT = 0x1406;
-const GL_FLOAT_VEC2 = 0x8b50;
-const GL_FLOAT_VEC3 = 0x8b51;
-const GL_FLOAT_VEC4 = 0x8b52;
-
-const GL_INT = 0x1404;
-const GL_INT_VEC2 = 0x8b53;
-const GL_INT_VEC3 = 0x8b54;
-const GL_INT_VEC4 = 0x8b55;
-
-const GL_UNSIGNED_INT = 0x1405;
-const GL_UNSIGNED_INT_VEC2 = 0x8dc6;
-const GL_UNSIGNED_INT_VEC3 = 0x8dc7;
-const GL_UNSIGNED_INT_VEC4 = 0x8dc8;
-
-const GL_BOOL = 0x8b56;
-const GL_BOOL_VEC2 = 0x8b57;
-const GL_BOOL_VEC3 = 0x8b58;
-const GL_BOOL_VEC4 = 0x8b59;
-
-const GL_FLOAT_MAT2 = 0x8b5a;
-const GL_FLOAT_MAT3 = 0x8b5b;
-const GL_FLOAT_MAT4 = 0x8b5c;
-
-const GL_FLOAT_MAT2x3 = 0x8b65;
-const GL_FLOAT_MAT2x4 = 0x8b66;
-const GL_FLOAT_MAT3x2 = 0x8b67;
-const GL_FLOAT_MAT3x4 = 0x8b68;
-const GL_FLOAT_MAT4x2 = 0x8b69;
-const GL_FLOAT_MAT4x3 = 0x8b6a;
-
-// Composite types table
-const COMPOSITE_GL_TYPES = {
-  [GL_FLOAT]: [GL_FLOAT, 1, 'float'],
-  [GL_FLOAT_VEC2]: [GL_FLOAT, 2, 'vec2'],
-  [GL_FLOAT_VEC3]: [GL_FLOAT, 3, 'vec3'],
-  [GL_FLOAT_VEC4]: [GL_FLOAT, 4, 'vec4'],
-
-  [GL_INT]: [GL_INT, 1, 'int'],
-  [GL_INT_VEC2]: [GL_INT, 2, 'ivec2'],
-  [GL_INT_VEC3]: [GL_INT, 3, 'ivec3'],
-  [GL_INT_VEC4]: [GL_INT, 4, 'ivec4'],
-
-  [GL_UNSIGNED_INT]: [GL_UNSIGNED_INT, 1, 'uint'],
-  [GL_UNSIGNED_INT_VEC2]: [GL_UNSIGNED_INT, 2, 'uvec2'],
-  [GL_UNSIGNED_INT_VEC3]: [GL_UNSIGNED_INT, 3, 'uvec3'],
-  [GL_UNSIGNED_INT_VEC4]: [GL_UNSIGNED_INT, 4, 'uvec4'],
-
-  [GL_BOOL]: [GL_FLOAT, 1, 'bool'],
-  [GL_BOOL_VEC2]: [GL_FLOAT, 2, 'bvec2'],
-  [GL_BOOL_VEC3]: [GL_FLOAT, 3, 'bvec3'],
-  [GL_BOOL_VEC4]: [GL_FLOAT, 4, 'bvec4'],
-
-  [GL_FLOAT_MAT2]: [GL_FLOAT, 8, 'mat2'], // 4
-  [GL_FLOAT_MAT2x3]: [GL_FLOAT, 8, 'mat2x3'], // 6
-  [GL_FLOAT_MAT2x4]: [GL_FLOAT, 8, 'mat2x4'], // 8
-
-  [GL_FLOAT_MAT3]: [GL_FLOAT, 12, 'mat3'], // 9
-  [GL_FLOAT_MAT3x2]: [GL_FLOAT, 12, 'mat3x2'], // 6
-  [GL_FLOAT_MAT3x4]: [GL_FLOAT, 12, 'mat3x4'], // 12
-
-  [GL_FLOAT_MAT4]: [GL_FLOAT, 16, 'mat4'], // 16
-  [GL_FLOAT_MAT4x2]: [GL_FLOAT, 16, 'mat4x2'], // 8
-  [GL_FLOAT_MAT4x3]: [GL_FLOAT, 16, 'mat4x3'] // 12
-};
-
-// Counts the number of complete primitives given a number of vertices and a drawMode
-export function getPrimitiveDrawMode(drawMode) {
-  switch (drawMode) {
-    case GL_POINTS:
-      return GL_POINTS;
-    case GL_LINES:
-      return GL_LINES;
-    case GL_LINE_STRIP:
-      return GL_LINES;
-    case GL_LINE_LOOP:
-      return GL_LINES;
-    case GL_TRIANGLES:
-      return GL_TRIANGLES;
-    case GL_TRIANGLE_STRIP:
-      return GL_TRIANGLES;
-    case GL_TRIANGLE_FAN:
-      return GL_TRIANGLES;
-    default:
-      assert(false);
-      return 0;
-  }
-}
-
-// Counts the number of complete "primitives" given a number of vertices and a drawMode
-export function getPrimitiveCount({drawMode, vertexCount}) {
-  switch (drawMode) {
-    case GL_POINTS:
-    case GL_LINE_LOOP:
-      return vertexCount;
-    case GL_LINES:
-      return vertexCount / 2;
-    case GL_LINE_STRIP:
-      return vertexCount - 1;
-    case GL_TRIANGLES:
-      return vertexCount / 3;
-    case GL_TRIANGLE_STRIP:
-    case GL_TRIANGLE_FAN:
-      return vertexCount - 2;
-    default:
-      assert(false);
-      return 0;
-  }
-}
-
-// Counts the number of vertices after splitting the vertex stream into separate "primitives"
-export function getVertexCount({drawMode, vertexCount}) {
-  const primitiveCount = getPrimitiveCount({drawMode, vertexCount});
-  switch (getPrimitiveDrawMode(drawMode)) {
-    case GL_POINTS:
-      return primitiveCount;
-    case GL_LINES:
-      return primitiveCount * 2;
-    case GL_TRIANGLES:
-      return primitiveCount * 3;
-    default:
-      assert(false);
-      return 0;
-  }
-}
-
-// Decomposes a composite type GL.VEC3 into a basic type (GL.FLOAT) and components (3)
-export function decomposeCompositeGLType(compositeGLType) {
-  const typeAndSize = COMPOSITE_GL_TYPES[compositeGLType];
-  if (!typeAndSize) {
-    return null;
-  }
-  const [type, components] = typeAndSize;
-  return {type, components};
-}
-
-export function getCompositeGLType(type, components) {
-  switch (type) {
-    case GL_BYTE:
-    case GL_UNSIGNED_BYTE:
-    case GL_SHORT:
-    case GL_UNSIGNED_SHORT:
-      type = GL_FLOAT;
-      break;
-    default:
-  }
-
-  for (const glType in COMPOSITE_GL_TYPES) {
-    const [compType, compComponents, name] = COMPOSITE_GL_TYPES[glType];
-    if (compType === type && compComponents === components) {
-      return {glType, name};
-    }
-  }
-  return null;
-}

package/src/webgl-utils/format-utils.ts

@@ -1,43 +0,0 @@
-import {assert} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-
-// Returns number of components in a specific readPixels WebGL format
-export function glFormatToComponents(format) {
-  switch (format) {
-    case GL.ALPHA:
-    case GL.R32F:
-    case GL.RED:
-      return 1;
-    case GL.RG32F:
-    case GL.RG:
-      return 2;
-    case GL.RGB:
-    case GL.RGB32F:
-      return 3;
-    case GL.RGBA:
-    case GL.RGBA32F:
-      return 4;
-    // TODO: Add support for additional WebGL2 formats
-    default:
-      assert(false);
-      return 0;
-  }
-}
-
-// Return byte count for given readPixels WebGL type
-export function glTypeToBytes(type) {
-  switch (type) {
-    case GL.UNSIGNED_BYTE:
-      return 1;
-    case GL.UNSIGNED_SHORT_5_6_5:
-    case GL.UNSIGNED_SHORT_4_4_4_4:
-    case GL.UNSIGNED_SHORT_5_5_5_1:
-      return 2;
-    case GL.FLOAT:
-      return 4;
-    // TODO: Add support for additional WebGL2 types
-    default:
-      assert(false);
-      return 0;
-  }
-}

package/src/webgl-utils/get-error.ts

@@ -1,56 +0,0 @@
-// Helper definitions for validation of webgl parameters
-/* eslint-disable no-inline-comments, max-len */
-
-// Errors - Constants returned from getError().
-const GL_NO_ERROR = 0; // Returned from getError.
-const GL_INVALID_ENUM = 0x0500; //  Returned from getError.
-const GL_INVALID_VALUE = 0x0501; //  Returned from getError.
-const GL_INVALID_OPERATION = 0x0502; //  Returned from getError.
-const GL_OUT_OF_MEMORY = 0x0505; //  Returned from getError.
-const GL_CONTEXT_LOST_WEBGL = 0x9242; //  Returned from getError.
-const GL_INVALID_FRAMEBUFFER_OPERATION = 0x0506;
-
-// GL errors
-
-const GL_ERROR_MESSAGES = {
-  //  If the WebGL context is lost, this error is returned on the
-  // first call to getError. Afterwards and until the context has been
-  // restored, it returns gl.NO_ERROR.
-  [GL_CONTEXT_LOST_WEBGL]: 'WebGL context lost',
-  // An unacceptable value has been specified for an enumerated argument.
-  [GL_INVALID_ENUM]: 'WebGL invalid enumerated argument',
-  // A numeric argument is out of range.
-  [GL_INVALID_VALUE]: 'WebGL invalid value',
-  // The specified command is not allowed for the current state.
-  [GL_INVALID_OPERATION]: 'WebGL invalid operation',
-  // The currently bound framebuffer is not framebuffer complete
-  // when trying to render to or to read from it.
-  [GL_INVALID_FRAMEBUFFER_OPERATION]: 'WebGL invalid framebuffer operation',
-  // Not enough memory is left to execute the command.
-  [GL_OUT_OF_MEMORY]: 'WebGL out of memory'
-};
-
-function glGetErrorMessage(gl, glError) {
-  return GL_ERROR_MESSAGES[glError] || `WebGL unknown error ${glError}`;
-}
-
-// Returns an Error representing the Latest webGl error or null
-export function glGetError(gl) {
-  // Loop to ensure all errors are cleared
-  const errorStack = [];
-  let glError = gl.getError();
-  while (glError !== GL_NO_ERROR) {
-    errorStack.push(glGetErrorMessage(gl, glError));
-    glError = gl.getError();
-  }
-  return errorStack.length ? new Error(errorStack.join('\n')) : null;
-}
-
-export function glCheckError(gl) {
-  if (gl.debug) {
-    const error = glGetError(gl);
-    if (error) {
-      throw error;
-    }
-  }
-}

package/src/webgl-utils/index.ts

@@ -1,12 +0,0 @@
-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/request-animation-frame.ts

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

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

@@ -1,60 +0,0 @@
-// TODO: Two subdirectories must not depend on each other (classes vs utils)!
-import {assert} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import Texture from '../classes/texture';
-import Texture2D from '../classes/texture-2d';
-import TextureCube from '../classes/texture-cube';
-import Texture3D from '../classes/texture-3d';
-import Framebuffer, {FramebufferProps} from '../classes/framebuffer';
-
-type TextureType = Texture2D | TextureCube | Texture3D;
-
-/** Clone a new texture object from a reference texture object. */
-export function cloneTextureFrom<T extends TextureType>(refTexture: T, overrides?: any): T {
-  assert(
-    refTexture instanceof Texture2D ||
-      refTexture instanceof TextureCube ||
-      refTexture instanceof Texture3D
-  );
-
-  const TextureType = refTexture.constructor;
-
-  const {gl, width, height, format, type, dataFormat, border, mipmaps} = refTexture;
-
-  const textureOptions = Object.assign(
-    {
-      width,
-      height,
-      format,
-      type,
-      dataFormat,
-      border,
-      mipmaps
-    },
-    overrides
-  );
-
-  // TODO: move this to `Texture` class as instance method and use this.constructor
-  // @ts-expect-error
-  return new TextureType(gl, textureOptions);
-}
-
-/**
- * Wraps a given texture into a framebuffer object, that can be further used
- * to read data from the texture object.
- */ 
-export function toFramebuffer(texture: Texture, opts?: FramebufferProps): Framebuffer {
-  const {gl, width, height, id} = texture;
-  const framebuffer = new Framebuffer(
-    gl,
-    Object.assign({}, opts, {
-      id: `framebuffer-for-${id}`,
-      width,
-      height,
-      attachments: {
-        [GL.COLOR_ATTACHMENT0]: texture
-      }
-    })
-  );
-  return framebuffer;
-}