@luma.gl/webgl 8.6.0-alpha.1 → 8.6.0-alpha.5

package/dist/context/context/get-canvas.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="offscreencanvas" />
+/**
+ * Creates a new canvas or returns the HTML element for a canvas.
+ * @param width
+ * @param height
+ * @returns
+ */
+export declare function getCanvas(options: {
+    canvas?: string | HTMLCanvasElement | OffscreenCanvas;
+    width: number;
+    height: number;
+}): HTMLCanvasElement | OffscreenCanvas;
+//# sourceMappingURL=get-canvas.d.ts.map

package/dist/context/context/get-canvas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-canvas.d.ts","sourceRoot":"","sources":["../../../src/context/context/get-canvas.ts"],"names":[],"mappings":";AAIA;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE;IACjC,MAAM,CAAC,EAAE,MAAM,GAAG,iBAAiB,GAAG,eAAe,CAAC;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAA;CACf,GAAG,iBAAiB,GAAG,eAAe,CAsBtC"}

package/dist/context/context/get-canvas.js

@@ -0,0 +1,31 @@
+import { isBrowser } from 'probe.gl/env';
+const isPage = isBrowser() && typeof document !== 'undefined';
+export function getCanvas(options) {
+  const {
+    canvas,
+    width = 800,
+    height = 600
+  } = options;
+
+  if (!canvas) {
+    const targetCanvas = document.createElement('canvas');
+    targetCanvas.id = 'lumagl-canvas';
+    targetCanvas.style.width = Number.isFinite(width) ? "".concat(width, "px") : '100%';
+    targetCanvas.style.height = Number.isFinite(height) ? "".concat(height, "px") : '100%';
+    document.body.insertBefore(targetCanvas, document.body.firstChild);
+    return targetCanvas;
+  }
+
+  if (typeof canvas === 'string') {
+    const isPageLoaded = isPage && document.readyState === 'complete';
+
+    if (!isPageLoaded) {
+      throw new Error("createGLContext called on canvas '".concat(canvas, "' before page was loaded"));
+    }
+
+    return document.getElementById(canvas);
+  }
+
+  return canvas;
+}
+//# sourceMappingURL=get-canvas.js.map

package/dist/context/context/get-canvas.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/context/get-canvas.ts"],"names":["isBrowser","isPage","document","getCanvas","options","canvas","width","height","targetCanvas","createElement","id","style","Number","isFinite","body","insertBefore","firstChild","isPageLoaded","readyState","Error","getElementById"],"mappings":"AACA,SAAQA,SAAR,QAAwB,cAAxB;AACA,MAAMC,MAAM,GAAGD,SAAS,MAAM,OAAOE,QAAP,KAAoB,WAAlD;AAQA,OAAO,SAASC,SAAT,CAAmBC,OAAnB,EAIiC;AACtC,QAAM;AAACC,IAAAA,MAAD;AAASC,IAAAA,KAAK,GAAG,GAAjB;AAAsBC,IAAAA,MAAM,GAAG;AAA/B,MAAsCH,OAA5C;;AAEA,MAAI,CAACC,MAAL,EAAa;AACX,UAAMG,YAAY,GAAGN,QAAQ,CAACO,aAAT,CAAuB,QAAvB,CAArB;AACAD,IAAAA,YAAY,CAACE,EAAb,GAAkB,eAAlB;AACAF,IAAAA,YAAY,CAACG,KAAb,CAAmBL,KAAnB,GAA2BM,MAAM,CAACC,QAAP,CAAgBP,KAAhB,cAA4BA,KAA5B,UAAwC,MAAnE;AACAE,IAAAA,YAAY,CAACG,KAAb,CAAmBJ,MAAnB,GAA4BK,MAAM,CAACC,QAAP,CAAgBN,MAAhB,cAA6BA,MAA7B,UAA0C,MAAtE;AACAL,IAAAA,QAAQ,CAACY,IAAT,CAAcC,YAAd,CAA2BP,YAA3B,EAAyCN,QAAQ,CAACY,IAAT,CAAcE,UAAvD;AACA,WAAOR,YAAP;AACD;;AAED,MAAI,OAAOH,MAAP,KAAkB,QAAtB,EAAgC;AAC9B,UAAMY,YAAY,GAAGhB,MAAM,IAAIC,QAAQ,CAACgB,UAAT,KAAwB,UAAvD;;AACA,QAAI,CAACD,YAAL,EAAmB;AACjB,YAAM,IAAIE,KAAJ,6CAA+Cd,MAA/C,8BAAN;AACD;;AAED,WAAOH,QAAQ,CAACkB,cAAT,CAAwBf,MAAxB,CAAP;AACD;;AAED,SAAOA,MAAP;AACD","sourcesContent":["// luma.gl, MIT license\nimport {isBrowser} from 'probe.gl/env';\nconst isPage = isBrowser() && typeof document !== 'undefined';\n\n/**\n * Creates a new canvas or returns the HTML element for a canvas.\n * @param width\n * @param height\n * @returns\n */\nexport function getCanvas(options: {\n  canvas?: string | HTMLCanvasElement | OffscreenCanvas,\n  width: number,\n  height: number\n}): HTMLCanvasElement | OffscreenCanvas {\n  const {canvas, width = 800, height = 600} = options;\n\n  if (!canvas) {\n    const targetCanvas = document.createElement('canvas');\n    targetCanvas.id = 'lumagl-canvas';\n    targetCanvas.style.width = Number.isFinite(width) ? `${width}px` : '100%';\n    targetCanvas.style.height = Number.isFinite(height) ? `${height}px` : '100%';\n    document.body.insertBefore(targetCanvas, document.body.firstChild);\n    return targetCanvas;\n  }\n\n  if (typeof canvas === 'string') {\n    const isPageLoaded = isPage && document.readyState === 'complete';\n    if (!isPageLoaded) {\n      throw new Error(`createGLContext called on canvas '${canvas}' before page was loaded`);\n    }\n    // TODO - check type?\n    return document.getElementById(canvas) as HTMLCanvasElement;\n  }\n\n  return canvas;\n}\n"],"file":"get-canvas.js"}

package/dist/context/context/resize-context.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Resize the canvas' drawing buffer.
+ *
+ * Can match the canvas CSS size, and optionally also consider devicePixelRatio
+ * Can be called every frame
+ *
+ * Regardless of size, the drawing buffer will always be scaled to the viewport, but
+ * for best visual results, usually set to either:
+ *  canvas CSS width x canvas CSS height
+ *  canvas CSS width * devicePixelRatio x canvas CSS height * devicePixelRatio
+ * See http://webgl2fundamentals.org/webgl/lessons/webgl-resizing-the-canvas.html
+ *
+ * resizeGLContext(gl, {width, height, useDevicePixels})
+ */
+export declare function resizeGLContext(gl: WebGLRenderingContext, options?: {
+    width?: number;
+    height?: number;
+    useDevicePixels?: boolean | number;
+}): void;
+//# sourceMappingURL=resize-context.d.ts.map

package/dist/context/context/resize-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resize-context.d.ts","sourceRoot":"","sources":["../../../src/context/context/resize-context.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACF,wBAAgB,eAAe,CAC9B,EAAE,EAAE,qBAAqB,EACzB,OAAO,CAAC,EAAE;IACR,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;CACpC,QAcF"}

package/dist/context/context/resize-context.js

@@ -0,0 +1,15 @@
+import { getDevicePixelRatio, setDevicePixelRatio } from "./device-pixels";
+export function resizeGLContext(gl, options) {
+  if (gl.canvas) {
+    const devicePixelRatio = getDevicePixelRatio(options === null || options === void 0 ? void 0 : options.useDevicePixels);
+    setDevicePixelRatio(gl, devicePixelRatio, options);
+    return;
+  }
+
+  const ext = gl.getExtension('STACKGL_resize_drawingbuffer');
+
+  if (ext && options && "width" in options && "height" in options) {
+    ext.resize(options.width, options.height);
+  }
+}
+//# sourceMappingURL=resize-context.js.map

package/dist/context/context/resize-context.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/context/resize-context.ts"],"names":["getDevicePixelRatio","setDevicePixelRatio","resizeGLContext","gl","options","canvas","devicePixelRatio","useDevicePixels","ext","getExtension","resize","width","height"],"mappings":"AACA,SAASA,mBAAT,EAA8BC,mBAA9B,QAAyD,iBAAzD;AAeC,OAAO,SAASC,eAAT,CACNC,EADM,EAENC,OAFM,EAON;AAEA,MAAID,EAAE,CAACE,MAAP,EAAe;AACb,UAAMC,gBAAgB,GAAGN,mBAAmB,CAACI,OAAD,aAACA,OAAD,uBAACA,OAAO,CAAEG,eAAV,CAA5C;AACAN,IAAAA,mBAAmB,CAACE,EAAD,EAAKG,gBAAL,EAAuBF,OAAvB,CAAnB;AACA;AACD;;AAGD,QAAMI,GAAG,GAAGL,EAAE,CAACM,YAAH,CAAgB,8BAAhB,CAAZ;;AACA,MAAID,GAAG,IAAIJ,OAAP,IAAkB,WAAWA,OAA7B,IAAwC,YAAYA,OAAxD,EAAiE;AAC/DI,IAAAA,GAAG,CAACE,MAAJ,CAAWN,OAAO,CAACO,KAAnB,EAA0BP,OAAO,CAACQ,MAAlC;AACD;AACF","sourcesContent":["// luma.gl, MIT license\nimport { getDevicePixelRatio, setDevicePixelRatio } from \"./device-pixels\";\n/**\n * Resize the canvas' drawing buffer.\n *\n * Can match the canvas CSS size, and optionally also consider devicePixelRatio\n * Can be called every frame\n *\n * Regardless of size, the drawing buffer will always be scaled to the viewport, but\n * for best visual results, usually set to either:\n *  canvas CSS width x canvas CSS height\n *  canvas CSS width * devicePixelRatio x canvas CSS height * devicePixelRatio\n * See http://webgl2fundamentals.org/webgl/lessons/webgl-resizing-the-canvas.html\n *\n * resizeGLContext(gl, {width, height, useDevicePixels})\n */\n export function resizeGLContext(\n  gl: WebGLRenderingContext,\n  options?: {\n    width?: number;\n    height?: number;\n    useDevicePixels?: boolean | number;\n  }\n) {\n  // Resize browser context .\n  if (gl.canvas) {\n    const devicePixelRatio = getDevicePixelRatio(options?.useDevicePixels);\n    setDevicePixelRatio(gl, devicePixelRatio, options);\n    return;\n  }\n\n  // Resize headless gl context\n  const ext = gl.getExtension('STACKGL_resize_drawingbuffer');\n  if (ext && options && `width` in options && `height` in options) {\n    ext.resize(options.width, options.height);\n  }\n}\n"],"file":"resize-context.js"}

package/dist/context/context/webgl-checks.d.ts

@@ -0,0 +1,13 @@
+export declare const ERR_WEBGL = "Invalid WebGLRenderingContext";
+export declare const ERR_WEBGL2 = "Requires WebGL2";
+/** Check if supplied parameter is a WebGLRenderingContext */
+export declare function isWebGL(gl: any): boolean;
+/** Check if supplied parameter is a WebGL2RenderingContext */
+export declare function isWebGL2(gl: any): boolean;
+/** Returns a properly typed WebGL2RenderingContext from a WebGL1 context, or null */
+export declare function getWebGL2Context(gl: WebGLRenderingContext): WebGL2RenderingContext | null;
+/** Throw if supplied parameter is not a WebGLRenderingContext, otherwise return properly typed value */
+export declare function assertWebGLContext(gl: any): WebGLRenderingContext;
+/** Throw if supplied parameter is not a WebGL2RenderingContext, otherwise return properly typed value */
+export declare function assertWebGL2Context(gl: any): WebGL2RenderingContext;
+//# sourceMappingURL=webgl-checks.d.ts.map

package/dist/context/context/webgl-checks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webgl-checks.d.ts","sourceRoot":"","sources":["../../../src/context/context/webgl-checks.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,SAAS,kCAAc,CAAC;AACrC,eAAO,MAAM,UAAU,oBAAoB,CAAC;AAG5C,6DAA6D;AAC7D,wBAAgB,OAAO,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CASxC;AAGD,8DAA8D;AAC9D,wBAAgB,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAMzC;AAGD,qFAAqF;AACrF,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,qBAAqB,GAAG,sBAAsB,GAAG,IAAI,CAGzF;AAGD,wGAAwG;AACxG,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,GAAG,GAAG,qBAAqB,CAGjE;AAED,yGAAyG;AACzG,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,GAAG,GAAG,sBAAsB,CAGnE"}

package/dist/context/context/webgl-checks.js

@@ -0,0 +1,34 @@
+import { assert } from '@luma.gl/api';
+const ERR_CONTEXT = 'Invalid WebGLRenderingContext';
+export const ERR_WEBGL = ERR_CONTEXT;
+export const ERR_WEBGL2 = 'Requires WebGL2';
+export function isWebGL(gl) {
+  if (typeof WebGLRenderingContext !== 'undefined' && gl instanceof WebGLRenderingContext) {
+    return true;
+  }
+
+  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {
+    return true;
+  }
+
+  return Boolean(gl && Number.isFinite(gl._version));
+}
+export function isWebGL2(gl) {
+  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {
+    return true;
+  }
+
+  return Boolean(gl && gl._version === 2);
+}
+export function getWebGL2Context(gl) {
+  return isWebGL2(gl) ? gl : null;
+}
+export function assertWebGLContext(gl) {
+  assert(isWebGL(gl), ERR_CONTEXT);
+  return gl;
+}
+export function assertWebGL2Context(gl) {
+  assert(isWebGL2(gl), ERR_WEBGL2);
+  return gl;
+}
+//# sourceMappingURL=webgl-checks.js.map

package/dist/context/context/webgl-checks.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/context/webgl-checks.ts"],"names":["assert","ERR_CONTEXT","ERR_WEBGL","ERR_WEBGL2","isWebGL","gl","WebGLRenderingContext","WebGL2RenderingContext","Boolean","Number","isFinite","_version","isWebGL2","getWebGL2Context","assertWebGLContext","assertWebGL2Context"],"mappings":"AACA,SAAQA,MAAR,QAAqB,cAArB;AAEA,MAAMC,WAAW,GAAG,+BAApB;AACA,OAAO,MAAMC,SAAS,GAAGD,WAAlB;AACP,OAAO,MAAME,UAAU,GAAG,iBAAnB;AAIP,OAAO,SAASC,OAAT,CAAiBC,EAAjB,EAAmC;AACxC,MAAI,OAAOC,qBAAP,KAAiC,WAAjC,IAAgDD,EAAE,YAAYC,qBAAlE,EAAyF;AACvF,WAAO,IAAP;AACD;;AACD,MAAI,OAAOC,sBAAP,KAAkC,WAAlC,IAAiDF,EAAE,YAAYE,sBAAnE,EAA2F;AACzF,WAAO,IAAP;AACD;;AAED,SAAOC,OAAO,CAACH,EAAE,IAAII,MAAM,CAACC,QAAP,CAAgBL,EAAE,CAACM,QAAnB,CAAP,CAAd;AACD;AAID,OAAO,SAASC,QAAT,CAAkBP,EAAlB,EAAoC;AACzC,MAAI,OAAOE,sBAAP,KAAkC,WAAlC,IAAiDF,EAAE,YAAYE,sBAAnE,EAA2F;AACzF,WAAO,IAAP;AACD;;AAED,SAAOC,OAAO,CAACH,EAAE,IAAIA,EAAE,CAACM,QAAH,KAAgB,CAAvB,CAAd;AACD;AAID,OAAO,SAASE,gBAAT,CAA0BR,EAA1B,EAAoF;AAEzF,SAAOO,QAAQ,CAACP,EAAD,CAAR,GAAeA,EAAf,GAAoB,IAA3B;AACD;AAID,OAAO,SAASS,kBAAT,CAA4BT,EAA5B,EAA4D;AACjEL,EAAAA,MAAM,CAACI,OAAO,CAACC,EAAD,CAAR,EAAcJ,WAAd,CAAN;AACA,SAAOI,EAAP;AACD;AAGD,OAAO,SAASU,mBAAT,CAA6BV,EAA7B,EAA8D;AACnEL,EAAAA,MAAM,CAACY,QAAQ,CAACP,EAAD,CAAT,EAAeF,UAAf,CAAN;AACA,SAAOE,EAAP;AACD","sourcesContent":["// luma.gl, MIT license\nimport {assert} from '@luma.gl/api';\n\nconst ERR_CONTEXT = 'Invalid WebGLRenderingContext';\nexport const ERR_WEBGL = ERR_CONTEXT;\nexport const ERR_WEBGL2 = 'Requires WebGL2';\n\n\n/** Check if supplied parameter is a WebGLRenderingContext */\nexport function isWebGL(gl: any): boolean {\n  if (typeof WebGLRenderingContext !== 'undefined' && gl instanceof WebGLRenderingContext) {\n    return true;\n  }\n  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {\n    return true;\n  }\n  // Look for debug contexts, headless gl etc\n  return Boolean(gl && Number.isFinite(gl._version));\n}\n\n\n/** Check if supplied parameter is a WebGL2RenderingContext */\nexport function isWebGL2(gl: any): boolean {\n  if (typeof WebGL2RenderingContext !== 'undefined' && gl instanceof WebGL2RenderingContext) {\n    return true;\n  }\n  // Look for debug contexts, headless gl etc\n  return Boolean(gl && gl._version === 2);\n}\n\n\n/** Returns a properly typed WebGL2RenderingContext from a WebGL1 context, or null */\nexport function getWebGL2Context(gl: WebGLRenderingContext): WebGL2RenderingContext | null {\n  // @ts-expect-error\n  return isWebGL2(gl) ? gl : null;\n}\n\n\n/** Throw if supplied parameter is not a WebGLRenderingContext, otherwise return properly typed value */\nexport function assertWebGLContext(gl: any): WebGLRenderingContext {\n  assert(isWebGL(gl), ERR_CONTEXT);\n  return gl;\n}\n\n/** Throw if supplied parameter is not a WebGL2RenderingContext, otherwise return properly typed value */\nexport function assertWebGL2Context(gl: any): WebGL2RenderingContext {\n  assert(isWebGL2(gl), ERR_WEBGL2);\n  return gl;\n}\n"],"file":"webgl-checks.js"}

package/dist/context/parameters/unified-parameter-api.d.ts

@@ -0,0 +1,31 @@
+import type { GLParameters } from './webgl-parameters';
+export type { GLParameters };
+/**
+ * Sets any GL parameter regardless of function (gl.blendMode, ...)
+ *
+ * @note requires a `cache` object to be set on the context (gl.state.cache)
+ * This object is used to fill in any missing values for composite setter functions
+ */
+export declare function setParameters(gl: WebGLRenderingContext, parameters: GLParameters): void;
+/**
+ * Reads the entire WebGL state from a context
+ * @returns - a newly created map, with values keyed by GL parameters
+ *
+ * @note Copies the state from a context (gl.getParameter should not be overriden)
+ * Reads the entire WebGL state from a context
+ *
+ * @note This can generates a huge amount of synchronous driver roundtrips and should be
+ * considered a very slow operation, to be used only if/when a context already manipulated
+ * by external code needs to be synchronized for the first time
+ */
+export declare function getParameters(gl: WebGLRenderingContext, parameters?: Record<keyof GLParameters, any>): GLParameters;
+export declare function getParameters(gl: WebGLRenderingContext, parameters?: (keyof GLParameters)[]): GLParameters;
+export declare function getParameters(gl: WebGLRenderingContext, parameters: keyof GLParameters): GLParameters;
+/**
+ * Reset all parameters to a (almost) pure context state
+ * @note viewport and scissor will be set to the values in GL_PARAMETER_DEFAULTS,
+ * NOT the canvas size dimensions, so they will have to be properly set after
+ * calling this function.
+ */
+export declare function resetParameters(gl: WebGLRenderingContext): void;
+//# sourceMappingURL=unified-parameter-api.d.ts.map

package/dist/context/parameters/unified-parameter-api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unified-parameter-api.d.ts","sourceRoot":"","sources":["../../../src/context/parameters/unified-parameter-api.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAUrD,YAAY,EAAC,YAAY,EAAC,CAAC;AAE3B;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,qBAAqB,EAAE,UAAU,EAAE,YAAY,GAAG,IAAI,CAgDvF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,aAAa,CAAC,EAAE,EAAE,qBAAqB,EAAE,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,YAAY,EAAE,GAAG,CAAC,GAAG,YAAY,CAAC;AACrH,wBAAgB,aAAa,CAAC,EAAE,EAAE,qBAAqB,EAAE,UAAU,CAAC,EAAE,CAAC,MAAM,YAAY,CAAC,EAAE,GAAG,YAAY,CAAC;AAC5G,wBAAgB,aAAa,CAAC,EAAE,EAAE,qBAAqB,EAAE,UAAU,EAAE,MAAM,YAAY,GAAG,YAAY,CAAC;AAwBvG;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,EAAE,EAAE,qBAAqB,GAAG,IAAI,CAE/D"}

package/dist/context/parameters/unified-parameter-api.js

@@ -0,0 +1,65 @@
+import { assert } from '@luma.gl/api';
+import { GL_PARAMETER_DEFAULTS, GL_PARAMETER_SETTERS, GL_COMPOSITE_PARAMETER_SETTERS, GL_PARAMETER_GETTERS } from './webgl-parameter-tables';
+import { isWebGL } from '../context/webgl-checks';
+export function setParameters(gl, parameters) {
+  assert(isWebGL(gl), 'setParameters requires a WebGL context');
+
+  if (isObjectEmpty(parameters)) {
+    return;
+  }
+
+  const compositeSetters = {};
+
+  for (const key in parameters) {
+    const glConstant = Number(key);
+    const setter = GL_PARAMETER_SETTERS[key];
+
+    if (setter) {
+      if (typeof setter === 'string') {
+        compositeSetters[setter] = true;
+      } else {
+        setter(gl, parameters[key], glConstant);
+      }
+    }
+  }
+
+  const cache = gl.state && gl.state.cache;
+
+  if (cache) {
+    for (const key in compositeSetters) {
+      const compositeSetter = GL_COMPOSITE_PARAMETER_SETTERS[key];
+      compositeSetter(gl, parameters, cache);
+    }
+  }
+}
+export function getParameters(gl, parameters) {
+  parameters = parameters || GL_PARAMETER_DEFAULTS;
+
+  if (typeof parameters === 'number') {
+    const key = parameters;
+    const getter = GL_PARAMETER_GETTERS[key];
+    return getter ? getter(gl, key) : gl.getParameter(key);
+  }
+
+  const parameterKeys = Array.isArray(parameters) ? parameters : Object.keys(parameters);
+  const state = {};
+
+  for (const key of parameterKeys) {
+    const getter = GL_PARAMETER_GETTERS[key];
+    state[key] = getter ? getter(gl, Number(key)) : gl.getParameter(Number(key));
+  }
+
+  return state;
+}
+export function resetParameters(gl) {
+  setParameters(gl, GL_PARAMETER_DEFAULTS);
+}
+
+function isObjectEmpty(object) {
+  for (const key in object) {
+    return false;
+  }
+
+  return true;
+}
+//# sourceMappingURL=unified-parameter-api.js.map

package/dist/context/parameters/unified-parameter-api.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/context/parameters/unified-parameter-api.ts"],"names":["assert","GL_PARAMETER_DEFAULTS","GL_PARAMETER_SETTERS","GL_COMPOSITE_PARAMETER_SETTERS","GL_PARAMETER_GETTERS","isWebGL","setParameters","gl","parameters","isObjectEmpty","compositeSetters","key","glConstant","Number","setter","cache","state","compositeSetter","getParameters","getter","getParameter","parameterKeys","Array","isArray","Object","keys","resetParameters","object"],"mappings":"AAGA,SAAQA,MAAR,QAAqB,cAArB;AAEA,SACEC,qBADF,EAEEC,oBAFF,EAGEC,8BAHF,EAIEC,oBAJF,QAKO,0BALP;AAOA,SAAQC,OAAR,QAAsB,yBAAtB;AAUA,OAAO,SAASC,aAAT,CAAuBC,EAAvB,EAAkDC,UAAlD,EAAkF;AACvFR,EAAAA,MAAM,CAACK,OAAO,CAACE,EAAD,CAAR,EAAc,wCAAd,CAAN;;AAEA,MAAIE,aAAa,CAACD,UAAD,CAAjB,EAA+B;AAC7B;AACD;;AAED,QAAME,gBAAgB,GAAG,EAAzB;;AAIA,OAAK,MAAMC,GAAX,IAAkBH,UAAlB,EAA8B;AAC5B,UAAMI,UAAU,GAAGC,MAAM,CAACF,GAAD,CAAzB;AACA,UAAMG,MAAM,GAAGZ,oBAAoB,CAACS,GAAD,CAAnC;;AACA,QAAIG,MAAJ,EAAY;AAEV,UAAI,OAAOA,MAAP,KAAkB,QAAtB,EAAgC;AAC9BJ,QAAAA,gBAAgB,CAACI,MAAD,CAAhB,GAA2B,IAA3B;AACD,OAFD,MAEO;AAKLA,QAAAA,MAAM,CAACP,EAAD,EAAKC,UAAU,CAACG,GAAD,CAAf,EAAsBC,UAAtB,CAAN;AACD;AACF;AACF;;AAUD,QAAMG,KAAK,GAAGR,EAAE,CAACS,KAAH,IAAYT,EAAE,CAACS,KAAH,CAASD,KAAnC;;AACA,MAAIA,KAAJ,EAAW;AACT,SAAK,MAAMJ,GAAX,IAAkBD,gBAAlB,EAAoC;AAElC,YAAMO,eAAe,GAAGd,8BAA8B,CAACQ,GAAD,CAAtD;AAGAM,MAAAA,eAAe,CAACV,EAAD,EAAKC,UAAL,EAAiBO,KAAjB,CAAf;AACD;AACF;AAGF;AAiBD,OAAO,SAASG,aAAT,CAAuBX,EAAvB,EAA2BC,UAA3B,EAAuC;AAE5CA,EAAAA,UAAU,GAAGA,UAAU,IAAIP,qBAA3B;;AAGA,MAAI,OAAOO,UAAP,KAAsB,QAA1B,EAAoC;AAElC,UAAMG,GAAG,GAAGH,UAAZ;AACA,UAAMW,MAAM,GAAGf,oBAAoB,CAACO,GAAD,CAAnC;AACA,WAAOQ,MAAM,GAAGA,MAAM,CAACZ,EAAD,EAAKI,GAAL,CAAT,GAAqBJ,EAAE,CAACa,YAAH,CAAgBT,GAAhB,CAAlC;AACD;;AAED,QAAMU,aAAa,GAAGC,KAAK,CAACC,OAAN,CAAcf,UAAd,IAA4BA,UAA5B,GAAyCgB,MAAM,CAACC,IAAP,CAAYjB,UAAZ,CAA/D;AAEA,QAAMQ,KAAK,GAAG,EAAd;;AACA,OAAK,MAAML,GAAX,IAAkBU,aAAlB,EAAiC;AAC/B,UAAMF,MAAM,GAAGf,oBAAoB,CAACO,GAAD,CAAnC;AACAK,IAAAA,KAAK,CAACL,GAAD,CAAL,GAAaQ,MAAM,GAAGA,MAAM,CAACZ,EAAD,EAAKM,MAAM,CAACF,GAAD,CAAX,CAAT,GAA6BJ,EAAE,CAACa,YAAH,CAAgBP,MAAM,CAACF,GAAD,CAAtB,CAAhD;AACD;;AACD,SAAOK,KAAP;AACD;AAQD,OAAO,SAASU,eAAT,CAAyBnB,EAAzB,EAA0D;AAC/DD,EAAAA,aAAa,CAACC,EAAD,EAAKN,qBAAL,CAAb;AACD;;AAKD,SAASQ,aAAT,CAAuBkB,MAAvB,EAA+B;AAC7B,OAAK,MAAMhB,GAAX,IAAkBgB,MAAlB,EAA0B;AACxB,WAAO,KAAP;AACD;;AACD,SAAO,IAAP;AACD","sourcesContent":["// Provides a unified API for getting and setting any WebGL parameter\n// Also knows default values of all parameters, enabling fast cache initialization\n// Provides base functionality for the state caching.\nimport {assert} from '@luma.gl/api';\nimport type {GLParameters} from './webgl-parameters';\nimport {\n  GL_PARAMETER_DEFAULTS,\n  GL_PARAMETER_SETTERS,\n  GL_COMPOSITE_PARAMETER_SETTERS,\n  GL_PARAMETER_GETTERS\n} from './webgl-parameter-tables';\n\nimport {isWebGL} from '../context/webgl-checks';\n\nexport type {GLParameters};\n\n/**\n * Sets any GL parameter regardless of function (gl.blendMode, ...)\n *\n * @note requires a `cache` object to be set on the context (gl.state.cache)\n * This object is used to fill in any missing values for composite setter functions\n */\nexport function setParameters(gl: WebGLRenderingContext, parameters: GLParameters): void {\n  assert(isWebGL(gl), 'setParameters requires a WebGL context');\n\n  if (isObjectEmpty(parameters)) {\n    return;\n  }\n\n  const compositeSetters = {};\n\n  // HANDLE PRIMITIVE SETTERS (and make note of any composite setters)\n\n  for (const key in parameters) {\n    const glConstant = Number(key);\n    const setter = GL_PARAMETER_SETTERS[key];\n    if (setter) {\n      // Composite setters should only be called once, so save them\n      if (typeof setter === 'string') {\n        compositeSetters[setter] = true;\n      } else {\n        // if (gl[glConstant] !== undefined) {\n        // TODO - added above check since this is being called on WebGL2 parameters in WebGL1...\n        // TODO - deep equal on values? only call setter if value has changed?\n        // NOTE - the setter will automatically update this.state\n        setter(gl, parameters[key], glConstant);\n      }\n    }\n  }\n\n  // HANDLE COMPOSITE SETTERS\n\n  // NOTE: any non-provided values needed by composite setters are filled in from state cache\n  // The cache parameter is automatically retrieved from the context\n  // This depends on `trackContextState`, which is technically a \"circular\" dependency.\n  // But it is too inconvenient to always require a cache parameter here.\n  // This is the ONLY external dependency in this module/\n  // @ts-expect-error\n  const cache = gl.state && gl.state.cache;\n  if (cache) {\n    for (const key in compositeSetters) {\n      // TODO - avoid calling composite setters if values have not changed.\n      const compositeSetter = GL_COMPOSITE_PARAMETER_SETTERS[key];\n      // Note - if `trackContextState` has been called,\n      // the setter will automatically update this.state.cache\n      compositeSetter(gl, parameters, cache);\n    }\n  }\n\n  // Add a log for the else case?\n}\n\n/**\n * Reads the entire WebGL state from a context\n * @returns - a newly created map, with values keyed by GL parameters\n *\n * @note Copies the state from a context (gl.getParameter should not be overriden)\n * Reads the entire WebGL state from a context\n *\n * @note This can generates a huge amount of synchronous driver roundtrips and should be\n * considered a very slow operation, to be used only if/when a context already manipulated\n * by external code needs to be synchronized for the first time\n */\nexport function getParameters(gl: WebGLRenderingContext, parameters?: Record<keyof GLParameters, any>): GLParameters;\nexport function getParameters(gl: WebGLRenderingContext, parameters?: (keyof GLParameters)[]): GLParameters;\nexport function getParameters(gl: WebGLRenderingContext, parameters: keyof GLParameters): GLParameters;\n\nexport function getParameters(gl, parameters) {\n  // default to querying all parameters\n  parameters = parameters || GL_PARAMETER_DEFAULTS;\n  // support both arrays of parameters and objects (keys represent parameters)\n\n  if (typeof parameters === 'number') {\n    // single GL enum\n    const key = parameters;\n    const getter = GL_PARAMETER_GETTERS[key];\n    return getter ? getter(gl, key) : gl.getParameter(key);\n  }\n\n  const parameterKeys = Array.isArray(parameters) ? parameters : Object.keys(parameters);\n\n  const state = {};\n  for (const key of parameterKeys) {\n    const getter = GL_PARAMETER_GETTERS[key];\n    state[key] = getter ? getter(gl, Number(key)) : gl.getParameter(Number(key));\n  }\n  return state;\n}\n\n/**\n * Reset all parameters to a (almost) pure context state\n * @note viewport and scissor will be set to the values in GL_PARAMETER_DEFAULTS,\n * NOT the canvas size dimensions, so they will have to be properly set after\n * calling this function.\n */\nexport function resetParameters(gl: WebGLRenderingContext): void {\n  setParameters(gl, GL_PARAMETER_DEFAULTS);\n}\n\n// Helpers\n\n// Returns true if given object is empty, false otherwise.\nfunction isObjectEmpty(object) {\n  for (const key in object) {\n    return false;\n  }\n  return true;\n}\n"],"file":"unified-parameter-api.js"}

package/dist/context/parameters/webgl-parameter-tables.d.ts

@@ -0,0 +1,169 @@
+import GL from '@luma.gl/constants';
+import { GLParameters } from './webgl-parameters';
+export declare const GL_PARAMETER_DEFAULTS: GLParameters;
+export declare const GL_PARAMETER_SETTERS: {
+    3042: (gl: any, value: any, key: any) => any;
+    32773: (gl: any, value: any) => any;
+    32777: string;
+    34877: string;
+    32969: string;
+    32968: string;
+    32971: string;
+    32970: string;
+    3106: (gl: any, value: any) => any;
+    3107: (gl: any, value: any) => any;
+    2884: (gl: any, value: any, key: any) => any;
+    2885: (gl: any, value: any) => any;
+    2929: (gl: any, value: any, key: any) => any;
+    2931: (gl: any, value: any) => any;
+    2932: (gl: any, value: any) => any;
+    2928: (gl: any, value: any) => any;
+    2930: (gl: any, value: any) => any;
+    3024: (gl: any, value: any, key: any) => any;
+    35723: (gl: any, value: any, key: any) => any;
+    35725: (gl: any, value: any) => any;
+    36007: (gl: any, value: any) => any;
+    36389: (gl: any, value: any) => any;
+    34229: (gl: any, value: any) => any;
+    36006: (gl: any, value: any, key: any) => any;
+    36010: (gl: any, value: any, key: any) => any;
+    34964: (gl: any, value: any, key: any) => void;
+    36662: (gl: any, value: any, key: any) => void;
+    36663: (gl: any, value: any, key: any) => void;
+    35053: (gl: any, value: any, key: any) => void;
+    35055: (gl: any, value: any, key: any) => void;
+    2886: (gl: any, value: any) => any;
+    33170: (gl: any, value: any, key: any) => any;
+    2849: (gl: any, value: any) => any;
+    32823: (gl: any, value: any, key: any) => any;
+    32824: string;
+    10752: string;
+    35977: (gl: any, value: any, key: any) => any;
+    32926: (gl: any, value: any, key: any) => any;
+    32928: (gl: any, value: any, key: any) => any;
+    32938: string;
+    32939: string;
+    3089: (gl: any, value: any, key: any) => any;
+    3088: (gl: any, value: any) => any;
+    2960: (gl: any, value: any, key: any) => any;
+    2961: (gl: any, value: any) => any;
+    2968: (gl: any, value: any) => any;
+    36005: (gl: any, value: any) => any;
+    2962: string;
+    2967: string;
+    2963: string;
+    34816: string;
+    36003: string;
+    36004: string;
+    2964: string;
+    2965: string;
+    2966: string;
+    34817: string;
+    34818: string;
+    34819: string;
+    2978: (gl: any, value: any) => any;
+    3333: (gl: any, value: any, key: any) => any;
+    3317: (gl: any, value: any, key: any) => any;
+    37440: (gl: any, value: any, key: any) => any;
+    37441: (gl: any, value: any, key: any) => any;
+    37443: (gl: any, value: any, key: any) => any;
+    3330: (gl: any, value: any, key: any) => any;
+    3332: (gl: any, value: any, key: any) => any;
+    3331: (gl: any, value: any, key: any) => any;
+    3314: (gl: any, value: any, key: any) => any;
+    32878: (gl: any, value: any, key: any) => any;
+    3316: (gl: any, value: any, key: any) => any;
+    3315: (gl: any, value: any, key: any) => any;
+    32877: (gl: any, value: any, key: any) => any;
+    framebuffer: (gl: any, framebuffer: any) => any;
+    blend: (gl: any, value: any) => any;
+    blendColor: (gl: any, value: any) => any;
+    blendEquation: (gl: any, args: any) => void;
+    blendFunc: (gl: any, args: any) => void;
+    clearColor: (gl: any, value: any) => any;
+    clearDepth: (gl: any, value: any) => any;
+    clearStencil: (gl: any, value: any) => any;
+    colorMask: (gl: any, value: any) => any;
+    cull: (gl: any, value: any) => any;
+    cullFace: (gl: any, value: any) => any;
+    depthTest: (gl: any, value: any) => any;
+    depthFunc: (gl: any, value: any) => any;
+    depthMask: (gl: any, value: any) => any;
+    depthRange: (gl: any, value: any) => any;
+    dither: (gl: any, value: any) => any;
+    derivativeHint: (gl: any, value: any) => void;
+    frontFace: (gl: any, value: any) => any;
+    mipmapHint: (gl: any, value: any) => any;
+    lineWidth: (gl: any, value: any) => any;
+    polygonOffsetFill: (gl: any, value: any) => any;
+    polygonOffset: (gl: any, value: any) => any;
+    sampleCoverage: (gl: any, value: any) => any;
+    scissorTest: (gl: any, value: any) => any;
+    scissor: (gl: any, value: any) => any;
+    stencilTest: (gl: any, value: any) => any;
+    stencilMask: (gl: any, value: any) => void;
+    stencilFunc: (gl: any, args: any) => void;
+    stencilOp: (gl: any, args: any) => void;
+    viewport: (gl: any, value: any) => any;
+};
+export declare const GL_COMPOSITE_PARAMETER_SETTERS: {
+    blendEquation: (gl: any, values: any, cache: any) => any;
+    blendFunc: (gl: any, values: any, cache: any) => any;
+    polygonOffset: (gl: any, values: any, cache: any) => any;
+    sampleCoverage: (gl: any, values: any, cache: any) => any;
+    stencilFuncFront: (gl: any, values: any, cache: any) => any;
+    stencilFuncBack: (gl: any, values: any, cache: any) => any;
+    stencilOpFront: (gl: any, values: any, cache: any) => any;
+    stencilOpBack: (gl: any, values: any, cache: any) => any;
+};
+export declare const GL_HOOKED_SETTERS: {
+    enable: (update: any, capability: any) => any;
+    disable: (update: any, capability: any) => any;
+    pixelStorei: (update: any, pname: any, value: any) => any;
+    hint: (update: any, pname: any, hint: any) => any;
+    useProgram: (update: any, value: any) => any;
+    bindRenderbuffer: (update: any, target: any, value: any) => any;
+    bindTransformFeedback: (update: any, target: any, value: any) => any;
+    bindVertexArray: (update: any, value: any) => any;
+    bindFramebuffer: (update: any, target: any, framebuffer: any) => any;
+    bindBuffer: (update: any, target: any, buffer: any) => any;
+    blendColor: (update: any, r: any, g: any, b: any, a: any) => any;
+    blendEquation: (update: any, mode: any) => any;
+    blendEquationSeparate: (update: any, modeRGB: any, modeAlpha: any) => any;
+    blendFunc: (update: any, src: any, dst: any) => any;
+    blendFuncSeparate: (update: any, srcRGB: any, dstRGB: any, srcAlpha: any, dstAlpha: any) => any;
+    clearColor: (update: any, r: any, g: any, b: any, a: any) => any;
+    clearDepth: (update: any, depth: any) => any;
+    clearStencil: (update: any, s: any) => any;
+    colorMask: (update: any, r: any, g: any, b: any, a: any) => any;
+    cullFace: (update: any, mode: any) => any;
+    depthFunc: (update: any, func: any) => any;
+    depthRange: (update: any, zNear: any, zFar: any) => any;
+    depthMask: (update: any, mask: any) => any;
+    frontFace: (update: any, face: any) => any;
+    lineWidth: (update: any, width: any) => any;
+    polygonOffset: (update: any, factor: any, units: any) => any;
+    sampleCoverage: (update: any, value: any, invert: any) => any;
+    scissor: (update: any, x: any, y: any, width: any, height: any) => any;
+    stencilMask: (update: any, mask: any) => any;
+    stencilMaskSeparate: (update: any, face: any, mask: any) => any;
+    stencilFunc: (update: any, func: any, ref: any, mask: any) => any;
+    stencilFuncSeparate: (update: any, face: any, func: any, ref: any, mask: any) => any;
+    stencilOp: (update: any, fail: any, zfail: any, zpass: any) => any;
+    stencilOpSeparate: (update: any, face: any, fail: any, zfail: any, zpass: any) => any;
+    viewport: (update: any, x: any, y: any, width: any, height: any) => any;
+};
+export declare const GL_PARAMETER_GETTERS: {
+    3042: (gl: any, key: any) => any;
+    2884: (gl: any, key: any) => any;
+    2929: (gl: any, key: any) => any;
+    3024: (gl: any, key: any) => any;
+    32823: (gl: any, key: any) => any;
+    32926: (gl: any, key: any) => any;
+    32928: (gl: any, key: any) => any;
+    3089: (gl: any, key: any) => any;
+    2960: (gl: any, key: any) => any;
+    35977: (gl: any, key: any) => any;
+};
+export declare const NON_CACHE_PARAMETERS: Set<GL>;
+//# sourceMappingURL=webgl-parameter-tables.d.ts.map

package/dist/context/parameters/webgl-parameter-tables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webgl-parameter-tables.d.ts","sourceRoot":"","sources":["../../../src/context/parameters/webgl-parameter-tables.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAEpC,OAAO,EAAC,YAAY,EAAC,MAAM,oBAAoB,CAAC;AAKhD,eAAO,MAAM,qBAAqB,EAAE,YAiFnC,CAAC;AAuCF,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgKhC,CAAC;AAOF,eAAO,MAAM,8BAA8B;;;;;;;;;CAmD1C,CAAC;AAGF,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsN7B,CAAC;AAOF,eAAO,MAAM,oBAAoB;;;;;;;;;;;CAahC,CAAC;AAEF,eAAO,MAAM,oBAAoB,SAuC/B,CAAC"}