@luma.gl/webgl 9.0.0-alpha.50 → 9.0.0-alpha.51

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/webgl",
-  "version": "9.0.0-alpha.50",
+  "version": "9.0.0-alpha.51",
   "description": "WebGL2 adapter for the luma.gl API",
   "type": "module",
   "license": "MIT",
@@ -44,12 +44,12 @@
   },
   "dependencies": {
     "@babel/runtime": "^7.0.0",
-    "@luma.gl/constants": "9.0.0-alpha.50",
-    "@luma.gl/core": "9.0.0-alpha.50",
+    "@luma.gl/constants": "9.0.0-alpha.51",
+    "@luma.gl/core": "9.0.0-alpha.51",
     "@probe.gl/env": "^4.0.2"
   },
   "devDependencies": {
-    "@luma.gl/test-utils": "9.0.0-alpha.50"
+    "@luma.gl/test-utils": "9.0.0-alpha.51"
   },
-  "gitHead": "83899806fcfab67f97cc8b308f81e4844a05ca05"
+  "gitHead": "368b615bdd46d0006717f004244a942f3d2812e7"
 }

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

@@ -1,9 +1,8 @@
 // luma.gl, MIT license
 // Copyright (c) vis.gl contributors
 
-import {log, uid, Shader, ShaderProps, CompilerMessage, formatCompilerLog} from '@luma.gl/core';
+import {Shader, ShaderProps, CompilerMessage} from '@luma.gl/core';
 import {GL} from '@luma.gl/constants';
-import {getShaderInfo} from '../helpers/get-shader-info';
 import {parseShaderCompilerLog} from '../helpers/parse-shader-compiler-log';
 import {WebGLDevice} from '../webgl-device';
 
@@ -15,7 +14,7 @@ export class WEBGLShader extends Shader {
   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':
@@ -39,15 +38,20 @@ export class WEBGLShader extends Shader {
     }
   }
 
-  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;
@@ -57,25 +61,24 @@ export class WEBGLShader extends Shader {
     // 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, {showSourceCode: true});
-      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/dist/adapter/helpers/get-shader-info.d.ts

@@ -1,9 +0,0 @@
-/** Information extracted from shader source code */
-export type ShaderInfo = {
-    name: string;
-    language: 'glsl' | 'wgsl';
-    version: number;
-};
-/** Extracts information from shader source code */
-export declare function getShaderInfo(source: string, defaultName?: string): ShaderInfo;
-//# sourceMappingURL=get-shader-info.d.ts.map

package/dist/adapter/helpers/get-shader-info.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-shader-info.d.ts","sourceRoot":"","sources":["../../../src/adapter/helpers/get-shader-info.ts"],"names":[],"mappings":"AAMA,oDAAoD;AACpD,MAAM,MAAM,UAAU,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,mDAAmD;AACnD,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,UAAU,CAM9E"}

package/dist/adapter/helpers/get-shader-info.js

@@ -1,25 +0,0 @@
-export function getShaderInfo(source, defaultName) {
-  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;
-}
-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;
-    }
-  }
-  return version;
-}
-//# sourceMappingURL=get-shader-info.js.map

package/dist/adapter/helpers/get-shader-info.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-shader-info.js","names":["getShaderInfo","source","defaultName","name","getShaderName","language","version","getShaderVersion","shader","arguments","length","undefined","SHADER_NAME_REGEXP","match","exec","words","v","parseInt","Number","isFinite"],"sources":["../../../src/adapter/helpers/get-shader-info.ts"],"sourcesContent":["// luma.gl, MIT license\n// Copyright (c) vis.gl contributors\n\n// Note: This was the only dependency that made @luma.gl/webgl depend on @luma.gl/shadertools\n// This file was coped from shadertools to avoid the dependency\n\n/** Information extracted from shader source code */\nexport type ShaderInfo = {\n  name: string;\n  language: 'glsl' | 'wgsl';\n  version: number;\n};\n\n/** Extracts information from shader source code */\nexport function getShaderInfo(source: string, defaultName?: string): ShaderInfo {\n  return {\n    name: getShaderName(source, defaultName),\n    language: 'glsl',\n    version: getShaderVersion(source)\n  };\n}\n\n/** Extracts GLSLIFY style naming of shaders: `#define SHADER_NAME ...` */\nfunction getShaderName(shader: string, defaultName: string = 'unnamed'): string {\n  const SHADER_NAME_REGEXP = /#define[\\s*]SHADER_NAME[\\s*]([A-Za-z0-9_-]+)[\\s*]/;\n  const match = SHADER_NAME_REGEXP.exec(shader);\n  return match ? match[1] : defaultName;\n}\n\n/** returns GLSL shader version of given shader string */\nfunction getShaderVersion(source: string): number {\n  let version = 100;\n  const words = source.match(/[^\\s]+/g);\n  if (words && words.length >= 2 && words[0] === '#version') {\n    const v = parseInt(words[1], 10);\n    if (Number.isFinite(v)) {\n      version = v;\n    }\n  }\n  return version;\n}\n"],"mappings":"AAcA,OAAO,SAASA,aAAaA,CAACC,MAAc,EAAEC,WAAoB,EAAc;EAC9E,OAAO;IACLC,IAAI,EAAEC,aAAa,CAACH,MAAM,EAAEC,WAAW,CAAC;IACxCG,QAAQ,EAAE,MAAM;IAChBC,OAAO,EAAEC,gBAAgB,CAACN,MAAM;EAClC,CAAC;AACH;AAGA,SAASG,aAAaA,CAACI,MAAc,EAA2C;EAAA,IAAzCN,WAAmB,GAAAO,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,SAAS;EACpE,MAAMG,kBAAkB,GAAG,mDAAmD;EAC9E,MAAMC,KAAK,GAAGD,kBAAkB,CAACE,IAAI,CAACN,MAAM,CAAC;EAC7C,OAAOK,KAAK,GAAGA,KAAK,CAAC,CAAC,CAAC,GAAGX,WAAW;AACvC;AAGA,SAASK,gBAAgBA,CAACN,MAAc,EAAU;EAChD,IAAIK,OAAO,GAAG,GAAG;EACjB,MAAMS,KAAK,GAAGd,MAAM,CAACY,KAAK,CAAC,SAAS,CAAC;EACrC,IAAIE,KAAK,IAAIA,KAAK,CAACL,MAAM,IAAI,CAAC,IAAIK,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;IACzD,MAAMC,CAAC,GAAGC,QAAQ,CAACF,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;IAChC,IAAIG,MAAM,CAACC,QAAQ,CAACH,CAAC,CAAC,EAAE;MACtBV,OAAO,GAAGU,CAAC;IACb;EACF;EACA,OAAOV,OAAO;AAChB"}

package/src/adapter/helpers/get-shader-info.ts

@@ -1,41 +0,0 @@
-// luma.gl, MIT license
-// Copyright (c) vis.gl contributors
-
-// Note: This was the only dependency that made @luma.gl/webgl depend on @luma.gl/shadertools
-// This file was coped from shadertools to avoid the dependency
-
-/** Information extracted from shader source code */
-export type ShaderInfo = {
-  name: string;
-  language: 'glsl' | 'wgsl';
-  version: number;
-};
-
-/** Extracts information from shader source code */
-export function getShaderInfo(source: string, defaultName?: string): ShaderInfo {
-  return {
-    name: getShaderName(source, defaultName),
-    language: 'glsl',
-    version: getShaderVersion(source)
-  };
-}
-
-/** Extracts GLSLIFY style naming of shaders: `#define SHADER_NAME ...` */
-function getShaderName(shader: string, defaultName: string = 'unnamed'): string {
-  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: string): number {
-  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;
-}