fixes for light and shadow effect

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

Author: igorDykhta

src/effects/src/custom-deck-lighting-effect.ts

@@ -1,131 +1,43 @@
 // SPDX-License-Identifier: MIT
 // Copyright contributors to the kepler.gl project
 
-// @ts-nocheck This is a hack, don't check types
+// @ts-nocheck
 
-import {LightingEffect, shadow} from '@deck.gl/core';
+import {LightingEffect} from '@deck.gl/core';
 
 /**
- * Inserts shader code before detected part.
- * @param {string} vs Original shader code.
- * @param {string} type Debug string.
- * @param {string} insertBeforeText Text chunk to insert before.
- * @param {string} textToInsert Text to insert.
- * @returns Modified shader code.
- */
-export function insertBefore(vs, type, insertBeforeText, textToInsert) {
-  const at = vs.indexOf(insertBeforeText);
-  if (at < 0) {
-    return vs;
-  }
-
-  return vs.slice(0, at) + textToInsert + vs.slice(at);
-}
-
-const CustomShadowModule = shadow ? {...shadow} : undefined;
-
-/**
- * Custom shadow module
- * 1) Add u_outputUniformShadow uniform
- * 2) always produce full shadow when the uniform is set to true.
- */
-if (CustomShadowModule?.fs) {
-  CustomShadowModule.fs = insertBefore(
-    CustomShadowModule.fs,
-    'custom shadow #1',
-    'uniform vec4 shadow_uColor;',
-    'uniform bool u_outputUniformShadow;'
-  );
-
-  CustomShadowModule.fs = insertBefore(
-    CustomShadowModule.fs,
-    'custom shadow #1',
-    'vec4 rgbaDepth = texture2D(shadowMap, position.xy);',
-    'if(u_outputUniformShadow) return 1.0;'
-  );
-}
-
-if (CustomShadowModule) {
-  CustomShadowModule.getUniforms = (opts = {}, context = {}) => {
-    const u = shadow.getUniforms(opts, context);
-    if (opts.outputUniformShadow !== undefined) {
-      u.u_outputUniformShadow = opts.outputUniformShadow;
-    }
-    return u;
-  };
-}
-
-/**
- * Custom LightingEffect
- * 1) adds CustomShadowModule
- * 2) pass outputUniformShadow as module parameters
- * 3) properly removes CustomShadowModule
+ * Custom LightingEffect for kepler.gl.
+ *
+ * This is a thin wrapper around deck.gl's LightingEffect. The original
+ * deck.gl 8 version patched the shadow shader module with custom GLSL,
+ * but that approach doesn't work with deck.gl 9's UBO-based shadow module.
+ *
+ * We override getShaderModuleProps to always include dummyShadowMap in
+ * the shadow props, even when shadows are disabled. This prevents "Bad
+ * texture binding" errors: the shadow module's createShadowUniforms needs
+ * a valid texture for shadow_uShadowMap0/1 bindings, and without
+ * dummyShadowMap it would set them to undefined.
  */
 class CustomDeckLightingEffect extends LightingEffect {
+  useOutputUniformShadow: boolean;
+
   constructor(props) {
     super(props);
     this.useOutputUniformShadow = false;
   }
 
-  preRender(context) {
-    if (!this.shadow) return;
-
-    // In deck.gl 9.x, preRender receives a context object instead of positional args
-    const device = context?.device;
-
-    this.shadowMatrices = this._calculateMatrices();
-
-    if (this.shadowPasses.length === 0) {
-      this._createShadowPasses(device);
-    }
-
-    if (!this.dummyShadowMap && device) {
-      this.dummyShadowMap = device.createTexture({
-        width: 1,
-        height: 1
-      });
-    }
+  getShaderModuleProps(layer, otherShaderModuleProps) {
+    const props = super.getShaderModuleProps(layer, otherShaderModuleProps);
 
-    for (let i = 0; i < this.shadowPasses.length; i++) {
-      const shadowPass = this.shadowPasses[i];
-      shadowPass.render({
-        layers: context.layers,
-        layerFilter: context.layerFilter,
-        viewports: context.viewports,
-        onViewportActive: context.onViewportActive,
-        views: context.views,
-        moduleParameters: {
-          shadowLightId: i,
-          dummyShadowMap: this.dummyShadowMap,
-          shadowMatrices: this.shadowMatrices,
-          useOutputUniformShadow: false
-        }
-      });
+    // When shadow is disabled, the parent returns shadow: {} without
+    // dummyShadowMap. The shadow module's getUniforms then sets
+    // shadow_uShadowMap0/1 to undefined, causing texture binding errors.
+    // Always provide the dummy texture so bindings remain valid.
+    if (props.shadow && !props.shadow.dummyShadowMap && this.dummyShadowMap) {
+      props.shadow.dummyShadowMap = this.dummyShadowMap;
     }
-  }
 
-  getModuleParameters(layer) {
-    const parameters = super.getModuleParameters(layer);
-    parameters.outputUniformShadow = this.outputUniformShadow;
-    return parameters;
-  }
-
-  cleanup() {
-    for (const shadowPass of this.shadowPasses) {
-      shadowPass.delete?.() || shadowPass.destroy?.();
-    }
-    this.shadowPasses.length = 0;
-    this.shadowMaps.length = 0;
-
-    if (this.dummyShadowMap) {
-      this.dummyShadowMap.delete?.() || this.dummyShadowMap.destroy?.();
-      this.dummyShadowMap = null;
-    }
-
-    if (this.shadow && this.programManager) {
-      this.programManager.removeDefaultModule?.(CustomShadowModule);
-      this.programManager = null;
-    }
+    return props;
   }
 }
 

src/utils/src/effect-utils.ts

@@ -31,9 +31,20 @@ export function computeDeckEffects({
   return visState.effectOrder
     .map(effectId => {
       const effect = findById(effectId)(visState.effects) as Effect | undefined;
-      if (effect?.isEnabled && effect.deckEffect) {
-        updateEffect({visState, mapState, effect});
-        return effect.deckEffect;
+      if (effect?.deckEffect) {
+        if (effect.isEnabled) {
+          updateEffect({visState, mapState, effect});
+        } else if (effect.type === LIGHT_AND_SHADOW_EFFECT.type) {
+          // Keep lighting effects in the array even when disabled to avoid
+          // removing the shadow shader module. Composite layer sublayers
+          // don't regenerate models when default shader modules change,
+          // leaving stale pipelines with shadow_uShadowMap bindings.
+          // Disabling shadow on the lights avoids visual effects.
+          disableLightingEffect(effect);
+        }
+        if (effect.isEnabled || effect.type === LIGHT_AND_SHADOW_EFFECT.type) {
+          return effect.deckEffect;
+        }
       }
       return null;
     })
@@ -78,11 +89,33 @@ function isDaytime(lat, lon, timestamp) {
   return date >= sunrise && date <= sunset;
 }
 
+/**
+ * Disable shadow rendering on a lighting effect without removing it.
+ * This keeps the shadow shader module registered and prevents stale
+ * texture binding errors in composite layer sublayers.
+ */
+function disableLightingEffect(effect: Effect) {
+  const deckEffect = effect.deckEffect;
+  if (!deckEffect) return;
+  deckEffect.shadow = false;
+  for (const light of deckEffect.directionalLights || []) {
+    light.shadow = false;
+  }
+}
+
 /**
  * Update effect to match latest vis and map states
  */
 function updateEffect({visState, mapState, effect}) {
   if (effect.type === LIGHT_AND_SHADOW_EFFECT.type) {
+    // Re-enable shadow rendering in case it was previously disabled
+    const deckEffect = effect.deckEffect;
+    for (const light of deckEffect.directionalLights || []) {
+      light._shadow = true;
+      light.shadow = true;
+    }
+    deckEffect.shadow = deckEffect.directionalLights?.some(l => l.shadow) ?? false;
+
     let {timestamp} = effect.parameters;
     const {timeMode} = effect.parameters;
     const sunLight = effect.deckEffect.directionalLights[0];