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

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;AAgBD,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 */\n export function getParameters(gl: WebGLRenderingContext, parameters?: Record<keyof GLParameters, any>): GLParameters;\n export function getParameters(gl: WebGLRenderingContext, parameters: number): any;\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"}