@luma.gl/webgl 9.1.0-alpha.14 → 9.1.0-alpha.16

package/src/context/debug/spector.ts

@@ -5,14 +5,14 @@
 import {log} from '@luma.gl/core';
 import {loadScript} from '../../utils/load-script';
 
-import {Spector} from './spector-types';
+import type {Spector} from './spector-types';
 
 /** Spector debug initialization options */
 type SpectorProps = {
-  /** Whether spector is enabled */
-  debugWithSpectorJS?: boolean;
+  /** Whether spector.js is enabled */
+  debugSpectorJS?: boolean;
   /** URL to load spector script from. Typically a CDN URL */
-  spectorUrl?: string;
+  debugSpectorJSUrl?: string;
   /** Canvas to monitor */
   gl?: WebGL2RenderingContext;
 };
@@ -29,19 +29,19 @@ declare global {
 }
 
 export const DEFAULT_SPECTOR_PROPS: Required<SpectorProps> = {
-  debugWithSpectorJS: log.get('spector') || log.get('spectorjs'),
+  debugSpectorJS: log.get('debug-spectorjs'),
   // https://github.com/BabylonJS/Spector.js#basic-usage
   // https://forum.babylonjs.com/t/spectorcdn-is-temporarily-off/48241
   // spectorUrl: 'https://spectorcdn.babylonjs.com/spector.bundle.js';
-  spectorUrl: 'https://cdn.jsdelivr.net/npm/spectorjs@0.9.30/dist/spector.bundle.js',
+  debugSpectorJSUrl: 'https://cdn.jsdelivr.net/npm/spectorjs@0.9.30/dist/spector.bundle.js',
   gl: undefined!
 };
 
 /** Loads spector from CDN if not already installed */
-export async function loadSpectorJS(props: {spectorUrl?: string}): Promise<void> {
+export async function loadSpectorJS(props: {debugSpectorJSUrl?: string}): Promise<void> {
   if (!globalThis.SPECTOR) {
     try {
-      await loadScript(props.spectorUrl || DEFAULT_SPECTOR_PROPS.spectorUrl);
+      await loadScript(props.debugSpectorJSUrl || DEFAULT_SPECTOR_PROPS.debugSpectorJSUrl);
     } catch (error) {
       log.warn(String(error));
     }
@@ -50,14 +50,14 @@ export async function loadSpectorJS(props: {spectorUrl?: string}): Promise<void>
 
 export function initializeSpectorJS(props: SpectorProps): Spector | null {
   props = {...DEFAULT_SPECTOR_PROPS, ...props};
-  if (!props.debugWithSpectorJS) {
+  if (!props.debugSpectorJS) {
     return null;
   }
 
   if (!spector && globalThis.SPECTOR && !globalThis.luma?.spector) {
     log.probe(LOG_LEVEL, 'SPECTOR found and initialized. Start with `luma.spector.displayUI()`')();
-    const {Spector} = globalThis.SPECTOR as any;
-    spector = new Spector();
+    const {Spector: SpectorJS} = globalThis.SPECTOR as any;
+    spector = new SpectorJS();
     if (globalThis.luma) {
       (globalThis.luma as any).spector = spector;
     }

package/src/context/debug/webgl-developer-tools.ts

@@ -11,18 +11,9 @@ import {loadScript} from '../../utils/load-script';
 const WEBGL_DEBUG_CDN_URL = 'https://unpkg.com/webgl-debug@2.0.1/index.js';
 
 type DebugContextProps = {
-  debug?: boolean;
-  throwOnError?: boolean;
-  break?: string[];
+  debugWebGL?: boolean;
 };
 
-// const DEFAULT_DEBUG_CONTEXT_PROPS: Required<DebugContextProps> = {
-//   debug: true,
-//   throwOnError: false,
-//   break: [],
-//   webgl2: false,
-// }
-
 type ContextData = {
   realContext?: WebGL2RenderingContext;
   debugContext?: WebGL2RenderingContext;
@@ -60,7 +51,7 @@ export function makeDebugContext(
   gl: WebGL2RenderingContext,
   props: DebugContextProps = {}
 ): WebGL2RenderingContext {
-  return props.debug ? getDebugContext(gl, props) : getRealContext(gl);
+  return props.debugWebGL ? getDebugContext(gl, props) : getRealContext(gl);
 }
 
 // Returns the real context from either of the real/debug contexts
@@ -136,9 +127,7 @@ function onGLError(props: DebugContextProps, err, functionName: string, args: an
   const message = `${errorMessage} in gl.${functionName}(${functionArgs})`;
   log.error(message)();
   debugger; // eslint-disable-line
-  if (props.throwOnError) {
-    throw new Error(message);
-  }
+  // throw new Error(message);
 }
 
 // Don't generate function string until it is needed
@@ -153,26 +142,11 @@ function onValidateGLFunc(
     log.log(1, functionString)();
   }
 
-  // If array of breakpoint strings supplied, check if any of them is contained in current GLEnum function
-  if (props.break && props.break.length > 0) {
-    functionString = functionString || getFunctionString(functionName, functionArgs);
-    const isBreakpoint = props.break.every(
-      (breakOn: string) => functionString.indexOf(breakOn) !== -1
-    );
-    if (isBreakpoint) {
-      debugger; // eslint-disable-line
-    }
-  }
-
   for (const arg of functionArgs) {
     if (arg === undefined) {
       functionString = functionString || getFunctionString(functionName, functionArgs);
-      if (props.throwOnError) {
-        throw new Error(`Undefined argument: ${functionString}`);
-      } else {
-        log.error(`Undefined argument: ${functionString}`)();
-        debugger; // eslint-disable-line
-      }
+      debugger; // eslint-disable-line
+      // throw new Error(`Undefined argument: ${functionString}`);
     }
   }
 }

package/src/context/helpers/create-browser-context.ts

@@ -5,37 +5,13 @@
 /**
  * ContextProps
  * @param onContextLost
- * @param onContextRestored
- *
- * BROWSER CONTEXT PARAMETERS
- * @param debug Instrument context (at the expense of performance).
- * @param alpha Default render target has an alpha buffer.
- * @param depth Default render target has a depth buffer of at least 16 bits.
- * @param stencil Default render target has a stencil buffer of at least 8 bits.
- * @param antialias Boolean that indicates whether or not to perform anti-aliasing.
- * @param premultipliedAlpha Boolean that indicates that the page compositor will assume the drawing buffer contains colors with pre-multiplied alpha.
- * @param preserveDrawingBuffer Default render target buffers will not be automatically cleared and will preserve their values until cleared or overwritten
- * @param failIfMajorPerformanceCaveat Do not create if the system performance is low.
+ * @param onContextRestored *
  */
 type ContextProps = {
-  onContextLost?: (event: Event) => void;
-  onContextRestored?: (event: Event) => void;
-  alpha?: boolean; // indicates if the canvas contains an alpha buffer.
-  desynchronized?: boolean; // hints the user agent to reduce the latency by desynchronizing the canvas paint cycle from the event loop
-  antialias?: boolean; // indicates whether or not to perform anti-aliasing.
-  depth?: boolean; // indicates that the drawing buffer has a depth buffer of at least 16 bits.
-  failIfMajorPerformanceCaveat?: boolean; // indicates if a context will be created if the system performance is low or if no hardware GPU is available.
-  powerPreference?: 'default' | 'high-performance' | 'low-power';
-  premultipliedAlpha?: boolean; // page compositor will assume the drawing buffer contains colors with pre-multiplied alpha.
-  preserveDrawingBuffer?: boolean; // buffers will not be cleared and will preserve their values until cleared or overwritten by the author.
-};
-
-const DEFAULT_CONTEXT_PROPS: ContextProps = {
-  powerPreference: 'high-performance', // After all, most apps are using WebGL for performance reasons
-  // eslint-disable-next-line no-console
-  onContextLost: () => console.error('WebGL context lost'),
-  // eslint-disable-next-line no-console
-  onContextRestored: () => console.info('WebGL context restored')
+  /** Called when a context is lost */
+  onContextLost: (event: Event) => void;
+  /** Called when a context is restored */
+  onContextRestored: (event: Event) => void;
 };
 
 /**
@@ -45,52 +21,51 @@ const DEFAULT_CONTEXT_PROPS: ContextProps = {
  */
 export function createBrowserContext(
   canvas: HTMLCanvasElement | OffscreenCanvas,
-  props: ContextProps
+  props: ContextProps,
+  webglContextAttributes: WebGLContextAttributes
 ): WebGL2RenderingContext {
-  props = {...DEFAULT_CONTEXT_PROPS, ...props};
-
   // Try to extract any extra information about why context creation failed
-  let errorMessage = null;
-  const onCreateError = error => (errorMessage = error.statusMessage || errorMessage);
-  canvas.addEventListener('webglcontextcreationerror', onCreateError, false);
-
-  // Create the desired context
-  let gl: WebGL2RenderingContext | null = null;
+  const errorMessage = null;
+  // const onCreateError = error => (errorMessage = error.statusMessage || errorMessage);
 
-  // props.failIfMajorPerformanceCaveat = true;
+  // Avoid multiple listeners?
+  // canvas.removeEventListener('webglcontextcreationerror', onCreateError, false);
+  // canvas.addEventListener('webglcontextcreationerror', onCreateError, false);
 
-  // We require webgl2 context
-  gl ||= canvas.getContext('webgl2', props) as WebGL2RenderingContext;
+  const webglProps: WebGLContextAttributes = {
+    preserveDrawingBuffer: true,
+    // failIfMajorPerformanceCaveat: true,
+    ...webglContextAttributes
+  };
 
-  // Software GPU
-
-  // props.failIfMajorPerformanceCaveat = false;
-
-  // if (!gl && props.webgl1) {
-  //   gl = canvas.getContext('webgl', props);
-  // }
+  // Create the desired context
+  let gl: WebGL2RenderingContext | null = null;
 
-  // TODO are we removing this listener before giving it a chance to fire?
-  canvas.removeEventListener('webglcontextcreationerror', onCreateError, false);
+  // Create a webgl2 context
+  gl ||= canvas.getContext('webgl2', webglProps);
+
+  // Creation failed with failIfMajorPerformanceCaveat - Try a Software GPU
+  if (!gl && !webglContextAttributes.failIfMajorPerformanceCaveat) {
+    webglProps.failIfMajorPerformanceCaveat = false;
+    gl = canvas.getContext('webgl', webglProps) as WebGL2RenderingContext;
+    // @ts-expect-error
+    gl.luma ||= {};
+    // @ts-expect-error
+    gl.luma.softwareRenderer = true;
+  }
 
   if (!gl) {
     throw new Error(`Failed to create WebGL context: ${errorMessage || 'Unknown error'}`);
   }
 
-  if (props.onContextLost) {
-    // Carefully extract and wrap callbacks to prevent addEventListener from rebinding them.
-    const {onContextLost} = props;
-    canvas.addEventListener('webglcontextlost', (event: Event) => onContextLost(event), false);
-  }
-  if (props.onContextRestored) {
-    // Carefully extract and wrap callbacks to prevent addEventListener from rebinding them.
-    const {onContextRestored} = props;
-    canvas.addEventListener(
-      'webglcontextrestored',
-      (event: Event) => onContextRestored(event),
-      false
-    );
-  }
+  // Carefully extract and wrap callbacks to prevent addEventListener from rebinding them.
+  const {onContextLost, onContextRestored} = props;
+  canvas.addEventListener('webglcontextlost', (event: Event) => onContextLost(event), false);
+  canvas.addEventListener(
+    'webglcontextrestored',
+    (event: Event) => onContextRestored(event),
+    false
+  );
 
   return gl;
 }