change luma shader validation logic for raster tile layer

Signed-off-by: Ihor Dykhta <dikhta.igor@gmail.com>

Author: igorDykhta

src/deckgl-layers/package.json

@@ -41,6 +41,7 @@
     "@luma.gl/constants": "^9.2.6",
     "@luma.gl/core": "^9.2.6",
     "@luma.gl/engine": "^9.2.6",
+    "@luma.gl/webgl": "^9.2.6",
     "@mapbox/geo-viewport": "^0.4.1",
     "@mapbox/vector-tile": "^1.3.1",
     "@math.gl/web-mercator": "^4.1.0",

src/deckgl-layers/src/raster/pipeline-validation-patch.ts

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+// @ts-nocheck
+
+/**
+ * Patch luma.gl 9's WEBGLRenderPipeline to tolerate mixed-sampler-type
+ * validation errors in _getLinkStatus().
+ *
+ * WebGL2's validateProgram checks that sampler uniforms of different types
+ * (sampler2D, usampler2D, isampler2D) are not assigned to the same texture
+ * unit. Before any draw call the default texture unit for all samplers is 0,
+ * so programs that mix sampler types (e.g. raster band data as usampler2D +
+ * colormap as sampler2D) always fail validation even though the program linked
+ * successfully and will work correctly once texture units are assigned at draw
+ * time.
+ *
+ * luma.gl calls validateProgram inside _getLinkStatus() immediately after
+ * linkProgram, before any texture units can be assigned. This patch keeps the
+ * full validateProgram call but ignores only the known false-positive about
+ * mixed sampler types. All other validation errors are still reported.
+ */
+
+import {WEBGLRenderPipeline} from '@luma.gl/webgl';
+
+const MIXED_SAMPLER_RE = /different type[s]? use the same sampler location/i;
+
+let _patched = false;
+
+export function patchPipelineValidation(): void {
+  if (_patched) return;
+  _patched = true;
+
+  if (!WEBGLRenderPipeline?.prototype?._getLinkStatus) {
+    return;
+  }
+
+  WEBGLRenderPipeline.prototype._getLinkStatus = function () {
+    const {gl} = this.device;
+    const linked = gl.getProgramParameter(this.handle, 0x8b82 /* LINK_STATUS */);
+    if (!linked) {
+      this.linkStatus = 'error';
+      return 'link-error';
+    }
+
+    gl.validateProgram(this.handle);
+    const validated = gl.getProgramParameter(this.handle, 0x8b83 /* VALIDATE_STATUS */);
+    if (!validated) {
+      const infoLog = gl.getProgramInfoLog(this.handle) || '';
+      if (!MIXED_SAMPLER_RE.test(infoLog)) {
+        // Real validation error — report it
+        this.linkStatus = 'error';
+        return 'validation-error';
+      }
+      // Mixed sampler types sharing default texture unit 0 before draw-time
+      // binding — this is a false positive, ignore it.
+    }
+
+    this.linkStatus = 'success';
+    return 'success';
+  };
+}

src/deckgl-layers/src/raster/raster-layer/raster-layer.ts

@@ -16,6 +16,9 @@ import {
 import {loadImages} from '../images';
 import type {RasterLayerAddedProps, ImageState} from '../types';
 import {modulesEqual} from '../util';
+import {patchPipelineValidation} from '../pipeline-validation-patch';
+
+patchPipelineValidation();
 
 const defaultProps = {
   ...BitmapLayer.defaultProps,
@@ -33,36 +36,9 @@ export default class RasterLayer extends BitmapLayer<RasterLayerAddedProps> {
   initializeState(): void {
     ensureRasterHooksRegistered();
     this.setState({images: {}});
-    this._patchValidateProgram();
     super.initializeState();
   }
 
-  /**
-   * Skip gl.validateProgram for this WebGL context.
-   * WebGL2 validateProgram fails with "Two textures of different types use the
-   * same sampler location" when sampler2D and usampler2D uniforms both default
-   * to texture unit 0 before any bindings are set. This is a false positive —
-   * proper texture units are assigned at draw time. Link errors and shader
-   * compilation errors are still caught without validateProgram.
-   */
-  _patchValidateProgram(): void {
-    const gl = this.context.device?.gl;
-    if (gl && !gl.__validateProgramPatched) {
-      gl.__validateProgramPatched = true;
-      const origGetProgramParameter = gl.getProgramParameter.bind(gl);
-      gl.validateProgram = function () {
-        // no op
-      };
-      gl.getProgramParameter = function (program: WebGLProgram, pname: number) {
-        if (pname === 0x8b83) {
-          // GL_VALIDATE_STATUS — always return true since we skip validation
-          return true;
-        }
-        return origGetProgramParameter(program, pname);
-      };
-    }
-  }
-
   draw(_opts: {shaderModuleProps: any}): void {
     const {model, images, coordinateConversion, bounds} = this.state;
     const {desaturate, transparentColor, tintColor, moduleProps} = this.props;

src/deckgl-layers/src/raster/raster-mesh-layer/raster-mesh-layer.ts

@@ -19,6 +19,9 @@ import {
 import {loadImages} from '../images';
 import type {RasterLayerAddedProps, ImageState} from '../types';
 import {modulesEqual} from '../util';
+import {patchPipelineValidation} from '../pipeline-validation-patch';
+
+patchPipelineValidation();
 
 type Mesh = SimpleMeshLayerProps['mesh'];
 
@@ -65,27 +68,9 @@ export default class RasterMeshLayer extends SimpleMeshLayer<any, RasterLayerAdd
   initializeState(): void {
     ensureRasterHooksRegistered();
     this.setState({images: {}});
-    this._patchValidateProgram();
     super.initializeState();
   }
 
-  _patchValidateProgram(): void {
-    const gl = this.context.device?.gl;
-    if (gl && !gl.__validateProgramPatched) {
-      gl.__validateProgramPatched = true;
-      const origGetProgramParameter = gl.getProgramParameter.bind(gl);
-      gl.validateProgram = function () {
-        // no op
-      };
-      gl.getProgramParameter = function (program: WebGLProgram, pname: number) {
-        if (pname === 0x8b83) {
-          return true;
-        }
-        return origGetProgramParameter(program, pname);
-      };
-    }
-  }
-
   getShaders(): any {
     const {modules = []} = this.props;
 

yarn.lock

@@ -5153,6 +5153,7 @@ __metadata:
     "@luma.gl/constants": "npm:^9.2.6"
     "@luma.gl/core": "npm:^9.2.6"
     "@luma.gl/engine": "npm:^9.2.6"
+    "@luma.gl/webgl": "npm:^9.2.6"
     "@mapbox/geo-viewport": "npm:^0.4.1"
     "@mapbox/vector-tile": "npm:^1.3.1"
     "@math.gl/web-mercator": "npm:^4.1.0"