@luma.gl/webgl 9.0.0-alpha.9 → 9.0.0-beta.1

package/src/adapter/resources/webgl-shader.ts

@@ -1,19 +1,20 @@
 // luma.gl, MIT license
-import {log, uid, Shader, ShaderProps} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import {getShaderInfo, CompilerMessage, formatCompilerLog} from '@luma.gl/shadertools';
+// Copyright (c) vis.gl contributors
+
+import {Shader, ShaderProps, CompilerMessage} from '@luma.gl/core';
+import {GL} from '@luma.gl/constants';
 import {parseShaderCompilerLog} from '../helpers/parse-shader-compiler-log';
-import WebGLDevice from '../webgl-device';
+import {WebGLDevice} from '../webgl-device';
 
 /**
  * An immutable compiled shader program that execute portions of the GPU Pipeline
  */
- export default class WEBGLShader extends Shader {
+export class WEBGLShader extends Shader {
   readonly device: WebGLDevice;
   readonly handle: WebGLShader;
 
   constructor(device: WebGLDevice, props: ShaderProps) {
-    super(device, {id: getShaderIdFromProps(props), ...props});
+    super(device, props);
     this.device = device;
     switch (this.props.stage) {
       case 'vertex':
@@ -28,7 +29,7 @@ import WebGLDevice from '../webgl-device';
     this._compile(this.source);
   }
 
-  destroy(): void {
+  override destroy(): void {
     if (this.handle) {
       this.removeStats();
       this.device.gl.deleteShader(this.handle);
@@ -37,15 +38,20 @@ import WebGLDevice from '../webgl-device';
     }
   }
 
-  async compilationInfo(): Promise<readonly CompilerMessage[]> {
+  override async getCompilationInfo(): Promise<readonly CompilerMessage[]> {
+    return this.getCompilationInfoSync();
+  }
+
+  override getCompilationInfoSync() {
     const log = this.device.gl.getShaderInfoLog(this.handle);
-    return log ? parseShaderCompilerLog(log) : [];
+    return parseShaderCompilerLog(log);
   }
 
   // PRIVATE METHODS
 
   _compile(source: string): void {
-    const addGLSLVersion = (source: string) => source.startsWith('#version ') ? source : `#version 100\n${source}`;
+    const addGLSLVersion = (source: string) =>
+      source.startsWith('#version ') ? source : `#version 100\n${source}`;
     source = addGLSLVersion(source);
 
     const {gl} = this.device;
@@ -55,25 +61,24 @@ import WebGLDevice from '../webgl-device';
     // TODO - For performance reasons, avoid checking shader compilation errors on production?
     // TODO - Load log even when no error reported, to catch warnings?
     // https://gamedev.stackexchange.com/questions/30429/how-to-detect-glsl-warnings
-    const compileStatus = gl.getShaderParameter(this.handle, GL.COMPILE_STATUS);
-    if (!compileStatus) {
-      const shaderLog = gl.getShaderInfoLog(this.handle);
-      const parsedLog = shaderLog ? parseShaderCompilerLog(shaderLog) : [];
-      const messages = parsedLog.filter(message => message.type === 'error');
-      const formattedLog = formatCompilerLog(messages, source);
-      const shaderName: string = getShaderInfo(source).name;
-      const shaderDescription = `${this.stage} shader ${shaderName}`;
-      log.error(`GLSL compilation errors in ${shaderDescription}\n${formattedLog}`)();
-      throw new Error(`GLSL compilation errors in ${shaderName}`);
+    this.compilationStatus = gl.getShaderParameter(this.handle, GL.COMPILE_STATUS) ? 'success' : 'error';
+
+    // The `Shader` base class will determine if debug window should be opened based on props
+    this.debugShader();
+
+    if (this.compilationStatus === 'error') {
+      throw new Error(`GLSL compilation errors in ${this.props.stage} shader ${this.props.id}`);
     }
   }
 }
 
-// HELPERS
+// TODO - Original code from luma.gl v8 - keep until new debug functionality has matured
+// if (!compilationSuccess) {
+//   const parsedLog = shaderLog ? parseShaderCompilerLog(shaderLog) : [];
+//   const messages = parsedLog.filter(message => message.type === 'error');
+//   const formattedLog = formatCompilerLog(messages, source, {showSourceCode: 'all', html: true});
+//   const shaderDescription = `${this.stage} shader ${shaderName}`;
+//   log.error(`GLSL compilation errors in ${shaderDescription}\n${formattedLog}`)();
+//   displayShaderLog(parsedLog, source, shaderName);
+// }
 
-/** Deduce an id, from shader source, or supplied id, or shader type */
-function getShaderIdFromProps(props: ShaderProps): string {
-  return getShaderInfo(props.source).name ||
-    props.id ||
-    uid(`unnamed ${props.stage}-shader`);
-}

package/src/adapter/resources/webgl-texture.ts

@@ -1,4 +1,6 @@
 // luma.gl, MIT license
+// Copyright (c) vis.gl contributors
+
 // Texture class.
 // @todo
 // - [ ] cube texture init params
@@ -10,15 +12,13 @@ import {
   Sampler,
   SamplerProps,
   SamplerParameters,
-  TypedArray,
-  isObjectEmpty
-} from '@luma.gl/api';
-import {Texture, cast, log, assert, isPowerOfTwo, loadImage} from '@luma.gl/api';
-import GL from '@luma.gl/constants';
-import type {GLSamplerParameters} from '../../types/webgl';
-import {withParameters} from '../../context/state-tracker/with-parameters';
+  TypedArray
+} from '@luma.gl/core';
+import {Texture, log, assert, isPowerOfTwo, loadImage, isObjectEmpty} from '@luma.gl/core';
+import {GL, GLSamplerParameters} from '@luma.gl/constants';
+import {withGLParameters} from '../../context/state-tracker/with-parameters';
 import {
-  getWebGLTextureFormat,
+  convertTextureFormatToGL,
   getWebGLTextureParameters,
   getTextureFormatBytesPerPixel
 } from '../converters/texture-formats';
@@ -26,20 +26,45 @@ import {
   convertSamplerParametersToWebGL,
   updateSamplerParametersForNPOT
 } from '../converters/sampler-parameters';
-import WebGLDevice from '../webgl-device';
-import WEBGLBuffer from './webgl-buffer';
-import WEBGLSampler from './webgl-sampler';
+import {WebGLDevice} from '../webgl-device';
+import {WEBGLBuffer} from './webgl-buffer';
+import {WEBGLSampler} from './webgl-sampler';
+
+export type WEBGLTextureProps = TextureProps & {
+  /** @deprecated use props.sampler */
+  parameters?: Record<number, number>;
+  /** @deprecated use props.data */
+  pixels?: any;
+  /** @deprecated use props.format */
+  dataFormat?: number | null;
+  /** @deprecated rarely supported */
+  border?: number;
+  /** @deprecated WebGL only. */
+  pixelStore?: object;
+  /** @deprecated WebGL only. */
+  textureUnit?: number;
+  /** @deprecated WebGL only. Use dimension. */
+  target?: number;
+};
 
-export type {TextureProps};
+export const DEFAULT_WEBGL_TEXTURE_PROPS = {
+  // deprecated
+  parameters: {},
+  pixelStore: {},
+  pixels: null,
+  border: 0,
+  dataFormat: undefined!,
+  textureUnit: undefined!,
+  target: undefined!
+};
 
-export type TextureSourceData = 
-  TypedArray |
-  ImageData |
-  HTMLImageElement |
-  HTMLCanvasElement |
-  ImageBitmap |
-  HTMLVideoElement
-  ;
+export type TextureSourceData =
+  | TypedArray
+  | ImageData
+  | HTMLImageElement
+  | HTMLCanvasElement
+  | ImageBitmap
+  | HTMLVideoElement;
 
 type SetImageDataOptions = {
   target?: number;
@@ -48,7 +73,7 @@ type SetImageDataOptions = {
   width?: number;
   height?: number;
   depth?: number;
-  format?: any;
+  glFormat?: GL;
   type?: any;
   offset?: number;
   data: any; // TextureSourceData;
@@ -56,7 +81,7 @@ type SetImageDataOptions = {
   parameters?: Record<GL, any>;
   /** @deprecated */
   pixels?: any;
-}
+};
 
 /**
  * @param {*} pixels, data -
@@ -87,7 +112,7 @@ type SetSubImageDataOptions = {
   width?: number;
   height?: number;
   depth?: number;
-  format?: any;
+  glFormat?: any;
   type?: any;
   offset?: number;
   data: any;
@@ -112,9 +137,8 @@ type SetImageData3DOptions = {
   parameters?: Record<GL, any>;
 };
 
-
 // Polyfill
-export default class WEBGLTexture extends Texture {
+export class WEBGLTexture extends Texture<WEBGLTextureProps> {
   // TODO - remove?
   static FACES: number[] = [
     GL.TEXTURE_CUBE_MAP_POSITIVE_X,
@@ -131,13 +155,12 @@ export default class WEBGLTexture extends Texture {
   readonly gl2: WebGL2RenderingContext | null;
   readonly handle: WebGLTexture;
 
-  data;
+  /** Sampler object (currently unused) */
+  sampler: WEBGLSampler = undefined;
 
-  width: number = undefined;
-  height: number = undefined;
-  depth: number = undefined;
+  // data;
 
-  format: GL = undefined;
+  glFormat: GL = undefined;
   type: GL = undefined;
   dataFormat: GL = undefined;
   mipmaps: boolean = undefined;
@@ -154,9 +177,6 @@ export default class WEBGLTexture extends Texture {
   target: GL;
   textureUnit: number = undefined;
 
-  /** Sampler object (currently unused) */
-  sampler: WEBGLSampler = undefined;
-
   /**
    * Program.draw() checks the loaded flag of all textures to avoid
    * Textures that are still loading from promises
@@ -169,16 +189,16 @@ export default class WEBGLTexture extends Texture {
     lastTime: number;
   };
 
-  constructor(device: Device, props: TextureProps) {
-    super(device, {format: GL.RGBA, ...props});
+  constructor(device: Device, props: WEBGLTextureProps) {
+    super(device, {...DEFAULT_WEBGL_TEXTURE_PROPS, format: 'rgba8unorm', ...props});
 
-    this.device = cast<WebGLDevice>(device);
+    this.device = device as WebGLDevice;
     this.gl = this.device.gl;
     this.gl2 = this.device.gl2;
     this.handle = this.props.handle || this.gl.createTexture();
-    // @ts-expect-error Per SPECTOR docs
-    this.handle.__SPECTOR_Metadata = {...this.props, data: typeof this.props.data}; // {name: this.props.id};
+    this.device.setSpectorMetadata(this.handle, {...this.props, data: typeof this.props.data}); // {name: this.props.id};
 
+    this.glFormat = GL.RGBA;
     this.target = getWebGLTextureTarget(this.props);
 
     // Program.draw() checks the loaded flag of all textures
@@ -194,7 +214,7 @@ export default class WEBGLTexture extends Texture {
     Object.seal(this);
   }
 
-  destroy(): void {
+  override destroy(): void {
     if (this.handle) {
       this.gl.deleteTexture(this.handle);
       this.removeStats();
@@ -204,12 +224,12 @@ export default class WEBGLTexture extends Texture {
     }
   }
 
-  toString(): string {
+  override toString(): string {
     return `Texture(${this.id},${this.width}x${this.height})`;
   }
 
   // eslint-disable-next-line max-statements
-  initialize(props: TextureProps = {}): this {
+  initialize(props: WEBGLTextureProps = {}): this {
     // Cube textures
     if (this.props.dimension === 'cube') {
       return this.initializeCube(props);
@@ -218,7 +238,7 @@ export default class WEBGLTexture extends Texture {
     let data = props.data;
 
     if (data instanceof Promise) {
-      data.then((resolvedImageData) =>
+      data.then(resolvedImageData =>
         this.initialize(
           Object.assign({}, props, {
             pixels: resolvedImageData,
@@ -238,10 +258,9 @@ export default class WEBGLTexture extends Texture {
       return this;
     }
 
-    let {parameters = {}  as Record<GL, any>} = props;
+    const {parameters = {} as Record<GL, any>} = props;
 
-    const {
-      pixels = null, recreate = false, pixelStore = {}, textureUnit = undefined} = props;
+    const {pixels = null, pixelStore = {}, textureUnit = undefined} = props;
 
     // pixels variable is for API compatibility purpose
     if (!data) {
@@ -254,6 +273,8 @@ export default class WEBGLTexture extends Texture {
     let {width, height, dataFormat, type, compressed = false, mipmaps = true} = props;
     const {depth = 0} = props;
 
+    const glFormat = convertTextureFormatToGL(props.format, this.device.isWebGL2);
+
     // Deduce width and height
     ({width, height, compressed, dataFormat, type} = this._deduceParameters({
       format: props.format,
@@ -265,13 +286,11 @@ export default class WEBGLTexture extends Texture {
       height
     }));
 
-    const format = getWebGLTextureFormat(this.gl, props.format);
-
     // Store opts for accessors
     this.width = width;
     this.height = height;
-    this.depth = depth;
-    this.format = format;
+    // this.depth = depth;
+    this.glFormat = glFormat;
     this.type = type;
     this.dataFormat = dataFormat;
     this.textureUnit = textureUnit;
@@ -293,10 +312,10 @@ export default class WEBGLTexture extends Texture {
       width,
       height,
       depth,
-      format,
+      format: glFormat,
       type,
       dataFormat,
-      // @ts-expect-error 
+      // @ts-expect-error
       parameters: pixelStore,
       compressed
     });
@@ -309,10 +328,6 @@ export default class WEBGLTexture extends Texture {
       this.generateMipmap();
     }
 
-    // TODO - Store data to enable auto recreate on context loss
-    if (recreate) {
-      this.data = data;
-    }
     if (isVideo) {
       this._video = {
         video: data as HTMLVideoElement,
@@ -325,8 +340,8 @@ export default class WEBGLTexture extends Texture {
     return this;
   }
 
-  initializeCube(props?: TextureProps): this {
-    const {mipmaps = true, parameters = {}  as Record<GL, any>} = props;
+  initializeCube(props?: WEBGLTextureProps): this {
+    const {mipmaps = true, parameters = {} as Record<GL, any>} = props;
 
     // Store props for accessors
     // this.props = props;
@@ -367,7 +382,7 @@ export default class WEBGLTexture extends Texture {
    * If size has changed, reinitializes with current format
    * @note note clears image and mipmaps
    */
-  resize(options: {height: number, width: number, mipmaps?: boolean}): this {
+  resize(options: {height: number; width: number; mipmaps?: boolean}): this {
     const {height, width, mipmaps = false} = options;
     if (width !== this.width || height !== this.height) {
       return this.initialize({
@@ -383,7 +398,7 @@ export default class WEBGLTexture extends Texture {
   }
 
   /** Update external texture (video frame) */
-  update(): this {
+  update(): void {
     if (this._video) {
       const {video, parameters, lastTime} = this._video;
       // @ts-expect-error
@@ -411,7 +426,7 @@ export default class WEBGLTexture extends Texture {
     this.mipmaps = true;
 
     this.gl.bindTexture(this.target, this.handle);
-    withParameters(this.gl, params, () => {
+    withGLParameters(this.gl, params, () => {
       this.gl.generateMipmap(this.target);
     });
     this.gl.bindTexture(this.target, null);
@@ -440,7 +455,7 @@ export default class WEBGLTexture extends Texture {
    */
   // eslint-disable-next-line max-statements, complexity
   setImageData(options: SetImageDataOptions) {
-    if (this.props.dimension === '3d') {
+    if (this.props.dimension === '3d' || this.props.dimension === '2d-array') {
       return this.setImageData3D(options);
     }
 
@@ -450,9 +465,9 @@ export default class WEBGLTexture extends Texture {
       target = this.target,
       pixels = null,
       level = 0,
-      format = this.format,
+      glFormat = this.glFormat,
       offset = 0,
-      parameters = {}  as Record<GL, any>
+      parameters = {} as Record<GL, any>
     } = options;
 
     let {
@@ -487,10 +502,20 @@ export default class WEBGLTexture extends Texture {
 
     let gl2;
 
-    withParameters(this.gl, parameters, () => {
+    withGLParameters(this.gl, parameters, () => {
       switch (dataType) {
         case 'null':
-          gl.texImage2D(target, level, format, width, height, 0 /*border*/, dataFormat, type, data);
+          gl.texImage2D(
+            target,
+            level,
+            glFormat,
+            width,
+            height,
+            0 /* border*/,
+            dataFormat,
+            type,
+            data
+          );
           break;
         case 'typed-array':
           // Looks like this assert is not necessary, as offset is ignored under WebGL1
@@ -498,7 +523,7 @@ export default class WEBGLTexture extends Texture {
           gl.texImage2D(
             target,
             level,
-            format,
+            glFormat,
             width,
             height,
             0, // border (must be 0)
@@ -516,10 +541,10 @@ export default class WEBGLTexture extends Texture {
           gl2.texImage2D(
             target,
             level,
-            format,
+            glFormat,
             width,
             height,
-            0 /*border*/,
+            0 /* border*/,
             dataFormat,
             type,
             offset
@@ -531,16 +556,16 @@ export default class WEBGLTexture extends Texture {
             gl.texImage2D(
               target,
               level,
-              format,
+              glFormat,
               width,
               height,
-              0 /*border*/,
+              0 /* border*/,
               dataFormat,
               type,
               data
             );
           } else {
-            gl.texImage2D(target, level, format, dataFormat, type, data);
+            gl.texImage2D(target, level, glFormat, dataFormat, type, data);
           }
           break;
         case 'compressed':
@@ -565,7 +590,7 @@ export default class WEBGLTexture extends Texture {
     if (data && data.byteLength) {
       this.trackAllocatedMemory(data.byteLength, 'Texture');
     } else {
-      const bytesPerPixel = getTextureFormatBytesPerPixel(this.gl, this.props.format);
+      const bytesPerPixel = getTextureFormatBytesPerPixel(this.props.format, this.device.isWebGL2);
       this.trackAllocatedMemory(this.width * this.height * bytesPerPixel, 'Texture');
     }
 
@@ -588,7 +613,7 @@ export default class WEBGLTexture extends Texture {
     width = this.width,
     height = this.height,
     level = 0,
-    format = this.format,
+    glFormat = this.glFormat,
     type = this.type,
     dataFormat = this.dataFormat,
     compressed = false,
@@ -627,10 +652,10 @@ export default class WEBGLTexture extends Texture {
 
     this.gl.bindTexture(this.target, this.handle);
 
-    withParameters(this.gl, parameters, () => {
+    withGLParameters(this.gl, parameters, () => {
       // TODO - x,y parameters
       if (compressed) {
-        this.gl.compressedTexSubImage2D(target, level, x, y, width, height, format, data);
+        this.gl.compressedTexSubImage2D(target, level, x, y, width, height, glFormat, data);
       } else if (data === null) {
         this.gl.texSubImage2D(target, level, x, y, width, height, dataFormat, type, null);
       } else if (ArrayBuffer.isView(data)) {
@@ -724,12 +749,12 @@ export default class WEBGLTexture extends Texture {
 
   // HELPER METHODS
 
-  _deduceParameters(opts: TextureProps) {
+  _deduceParameters(opts: WEBGLTextureProps) {
     const {format, data} = opts;
     let {width, height, dataFormat, type, compressed} = opts;
 
     // Deduce format and type from format
-    const parameters = getWebGLTextureParameters(this.gl, format);
+    const parameters = getWebGLTextureParameters(format, this.device.isWebGL2);
     dataFormat = dataFormat || parameters.dataFormat;
     type = type || parameters.type;
     compressed = compressed || parameters.compressed;
@@ -802,7 +827,7 @@ export default class WEBGLTexture extends Texture {
     // ... }
 
     const resolvedFaces = await Promise.all(
-      WEBGLTexture.FACES.map((face) => {
+      WEBGLTexture.FACES.map(face => {
         const facePixels = imageDataMap[face];
         return Promise.all(Array.isArray(facePixels) ? facePixels : [facePixels]);
       })
@@ -819,7 +844,7 @@ export default class WEBGLTexture extends Texture {
       resolvedFaces[index].forEach((image, lodLevel) => {
         // TODO: adjust width & height for LOD!
         if (width && height) {
-          gl.texImage2D(face, lodLevel, format, width, height, 0 /*border*/, format, type, image);
+          gl.texImage2D(face, lodLevel, format, width, height, 0 /* border*/, format, type, image);
         } else {
           gl.texImage2D(face, lodLevel, format, format, type, image);
         }
@@ -848,7 +873,7 @@ export default class WEBGLTexture extends Texture {
 
     this.bind();
     if (imageData instanceof Promise) {
-      imageData.then((resolvedImageData) =>
+      imageData.then(resolvedImageData =>
         this.setImageDataForFace(
           Object.assign({}, options, {
             face,
@@ -858,7 +883,7 @@ export default class WEBGLTexture extends Texture {
         )
       );
     } else if (this.width || this.height) {
-      gl.texImage2D(face, 0, format, width, height, 0 /*border*/, format, type, imageData);
+      gl.texImage2D(face, 0, format, width, height, 0 /* border*/, format, type, imageData);
     } else {
       gl.texImage2D(face, 0, format, format, type, imageData);
     }
@@ -885,9 +910,9 @@ export default class WEBGLTexture extends Texture {
 
     this.gl.bindTexture(this.target, this.handle);
 
-    const webglTextureFormat = getWebGLTextureParameters(this.gl, format);
+    const webglTextureFormat = getWebGLTextureParameters(format, this.device.isWebGL2);
 
-    withParameters(this.gl, parameters, () => {
+    withGLParameters(this.gl, parameters, () => {
       if (ArrayBuffer.isView(data)) {
         // @ts-expect-error
         this.gl.texImage3D(
@@ -925,7 +950,7 @@ export default class WEBGLTexture extends Texture {
     if (data && data.byteLength) {
       this.trackAllocatedMemory(data.byteLength, 'Texture');
     } else {
-      const bytesPerPixel = getTextureFormatBytesPerPixel(this.gl, this.props.format);
+      const bytesPerPixel = getTextureFormatBytesPerPixel(this.props.format, this.device.isWebGL2);
       this.trackAllocatedMemory(this.width * this.height * this.depth * bytesPerPixel, 'Texture');
     }
 
@@ -940,7 +965,7 @@ export default class WEBGLTexture extends Texture {
    * Sets sampler parameters on texture
    * @note: Applies NPOT workaround if appropriate
    */
-  _setSamplerParameters(parameters: GLSamplerParameters) {
+  _setSamplerParameters(parameters: GLSamplerParameters): void {
     // Work around WebGL1 sampling restrictions on NPOT textures
     if (this.device.isWebGL1 && isNPOT(this.width, this.height)) {
       parameters = updateSamplerParametersForNPOT(parameters);
@@ -955,8 +980,8 @@ export default class WEBGLTexture extends Texture {
 
     this.gl.bindTexture(this.target, this.handle);
     for (const [pname, pvalue] of Object.entries(parameters)) {
-      const param = Number(pname);
-      let value = pvalue;
+      const param = Number(pname) as GL.TEXTURE_MIN_LOD | GL.TEXTURE_MAX_LOD;
+      const value = pvalue;
 
       // Apparently there are integer/float conversion issues requires two parameter setting functions in JavaScript.
       // For now, pick the float version for parameters specified as GLfloat.
@@ -972,11 +997,14 @@ export default class WEBGLTexture extends Texture {
       }
     }
     this.gl.bindTexture(this.target, null);
-    return this;
+    return;
   }
 
   /** @deprecated For LegacyTexture subclass */
-  protected _getWebGL1NPOTParameterOverride(pname: number, value: number): number {
+  protected _getWebGL1NPOTParameterOverride(
+    pname: GL.TEXTURE_MIN_FILTER | GL.TEXTURE_WRAP_S | GL.TEXTURE_WRAP_T,
+    value: GL.LINEAR | GL.NEAREST
+  ): number {
     // NOTE: Apply NPOT workaround
     const npot = this.device.isWebGL1 && isNPOT(this.width, this.height);
     if (npot) {
@@ -1031,6 +1059,4 @@ function isNPOT(width: number, height: number): boolean {
 
 function logParameters(parameters: Record<number, GL | number>) {
   log.log(1, 'texture sampler parameters', parameters)();
-  for (const [pname, pvalue] of Object.entries(parameters)) {
-  }
 }