@zephyr3d/editor 0.3.8 → 0.3.9

package/dist/vendor/zephyr3d/scene/dist/shadow/shadowmapper.js

@@ -3,8 +3,8 @@ import { Camera } from '../camera/camera.js';
 import { SSM } from './ssm.js';
 import { ESM } from './esm.js';
 import { VSM } from './vsm.js';
-import { PCFPD } from './pcf_pd.js';
 import { PCFOPT } from './pcf_opt.js';
+import { PCSS } from './pcss.js';
 import { LIGHT_TYPE_NONE, LIGHT_TYPE_DIRECTIONAL, LIGHT_TYPE_POINT } from '../values.js';
 import { ShaderHelper } from '../material/shader/helper.js';
 import { getDevice } from '../app/api.js';
@@ -13,9 +13,9 @@ import { ShadowRegion } from './shadow_region.js';
 const tmpMatrix = new Matrix4x4();
 const tmpFrustum = new Frustum(Matrix4x4.identity());
 // const zeroPosition = Vector3.zero();
-/**
- * The shadow map generator
- * @public
+/**
+ * The shadow map generator
+ * @public
  */ class ShadowMapper extends Disposable {
     /** @internal */ static _snapMatrix = new Matrix4x4();
     /** @internal */ static _target = new Vector3();
@@ -34,6 +34,11 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
     /** @internal */ _pdSampleCount;
     /** @internal */ _pdSampleRadius;
     /** @internal */ _pcfKernelSize;
+    /** @internal */ _pcssLightRadius;
+    /** @internal */ _pcssBlockerSampleCount;
+    /** @internal */ _pcssFilterSampleCount;
+    /** @internal */ _pcssMaxFilterRadius;
+    /** @internal */ _pcssTemporalJitter;
     /** @internal */ _vsmBlurKernelSize;
     /** @internal */ _vsmBlurRadius;
     /** @internal */ _vsmDarkness;
@@ -44,9 +49,9 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
     /** @internal */ _esmDepthScale;
     /** @internal */ _shadowStrength;
     /** @internal */ _shadowRegion;
-    /**
-   * Creates an instance of ShadowMapper
-   * @param light - The light that is used to generate shadow map
+    /**
+   * Creates an instance of ShadowMapper
+   * @param light - The light that is used to generate shadow map
    */ constructor(light){
         super();
         this._light = light;
@@ -59,12 +64,17 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             nearClip: 1
         };
         this._resourceDirty = true;
-        this._shadowMode = 'pcf-pd';
+        this._shadowMode = 'pcf';
         this._shadowDistance = 2000;
         this._impl = null;
         this._pdSampleCount = 24;
         this._pdSampleRadius = 3;
         this._pcfKernelSize = 7;
+        this._pcssLightRadius = 8;
+        this._pcssBlockerSampleCount = 24;
+        this._pcssFilterSampleCount = 32;
+        this._pcssMaxFilterRadius = 32;
+        this._pcssTemporalJitter = true;
         this._vsmBlurKernelSize = 5;
         this._vsmBlurRadius = 4;
         this._vsmDarkness = 0.3;
@@ -194,14 +204,14 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             this.applyMode(this._shadowMode);
         }
     }
-    /**
-   * Applies a practical shadow preset for common scenarios.
-   *
-   * `character-small`: higher contact quality and tighter distance for character-centric scenes.
-   * `outdoor-large`: longer distance coverage for open scenes.
+    /**
+   * Applies a practical shadow preset for common scenarios.
+   *
+   * `character-small`: higher contact quality and tighter distance for character-centric scenes.
+   * `outdoor-large`: longer distance coverage for open scenes.
    */ applyQualityPreset(preset) {
         if (preset === 'character-small') {
-            this.mode = 'pcf-opt';
+            this.mode = 'pcf';
             this.shadowMapSize = 2048;
             this.shadowDistance = 120;
             this.splitLambda = 0.75;
@@ -212,7 +222,7 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             this.numShadowCascades = this._light.isDirectionLight() ? 3 : 1;
             return;
         }
-        this.mode = 'pcf-opt';
+        this.mode = 'pcf';
         this.shadowMapSize = 2048;
         this.shadowDistance = 800;
         this.splitLambda = 0.6;
@@ -261,6 +271,71 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             }
         }
     }
+    /** Light radius for PCSS shadow, measured in shadow-map texels */ get pcssLightRadius() {
+        return this._pcssLightRadius;
+    }
+    set pcssLightRadius(val) {
+        val = Math.max(0, Number(val) || 0);
+        if (val !== this._pcssLightRadius) {
+            this._pcssLightRadius = val;
+            const pcss = this.asPCSS();
+            if (pcss) {
+                pcss.lightRadius = this._pcssLightRadius;
+            }
+        }
+    }
+    /** Blocker search sample count for PCSS shadow */ get pcssBlockerSampleCount() {
+        return this._pcssBlockerSampleCount;
+    }
+    set pcssBlockerSampleCount(val) {
+        val = Math.min(Math.max(1, Number(val) >> 0), 64);
+        if (val !== this._pcssBlockerSampleCount) {
+            this._pcssBlockerSampleCount = val;
+            const pcss = this.asPCSS();
+            if (pcss) {
+                pcss.blockerSampleCount = this._pcssBlockerSampleCount;
+            }
+        }
+    }
+    /** Filter sample count for PCSS shadow */ get pcssFilterSampleCount() {
+        return this._pcssFilterSampleCount;
+    }
+    set pcssFilterSampleCount(val) {
+        val = Math.min(Math.max(1, Number(val) >> 0), 64);
+        if (val !== this._pcssFilterSampleCount) {
+            this._pcssFilterSampleCount = val;
+            const pcss = this.asPCSS();
+            if (pcss) {
+                pcss.filterSampleCount = this._pcssFilterSampleCount;
+            }
+        }
+    }
+    /** Maximum PCSS filter radius, measured in shadow-map texels */ get pcssMaxFilterRadius() {
+        return this._pcssMaxFilterRadius;
+    }
+    set pcssMaxFilterRadius(val) {
+        val = Math.max(1, Number(val) || 1);
+        if (val !== this._pcssMaxFilterRadius) {
+            this._pcssMaxFilterRadius = val;
+            const pcss = this.asPCSS();
+            if (pcss) {
+                pcss.maxFilterRadius = this._pcssMaxFilterRadius;
+            }
+        }
+    }
+    /** If true, rotates PCSS sampling pattern over frames for TAA accumulation */ get pcssTemporalJitter() {
+        return this._pcssTemporalJitter;
+    }
+    set pcssTemporalJitter(val) {
+        val = !!val;
+        if (val !== this._pcssTemporalJitter) {
+            this._pcssTemporalJitter = val;
+            const pcss = this.asPCSS();
+            if (pcss) {
+                pcss.temporalJitter = this._pcssTemporalJitter;
+            }
+        }
+    }
     /** Kernel size of VSM */ get vsmBlurKernelSize() {
         return this._vsmBlurKernelSize;
     }
@@ -448,28 +523,28 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
         const useTextureArray = numCascades > 1 && device.type !== 'webgl';
         const shadowMapWidth = numCascades > 1 && !useTextureArray ? 2 * this._config.shadowMapSize : this._config.shadowMapSize;
         const shadowMapHeight = numCascades > 2 && !useTextureArray ? 2 * this._config.shadowMapSize : this._config.shadowMapSize;
-        /*
-    const colorAttachments = colorFormat
-      ? useTextureArray
-        ? [device.pool.fetchTemporalTexture2DArray(false, colorFormat, shadowMapWidth, shadowMapHeight, numCascades, false)]
-        : this._light.isPointLight()
-          ? [device.pool.fetchTemporalTextureCube(false, colorFormat, shadowMapWidth, false)]
-          : [device.pool.fetchTemporalTexture2D(false, colorFormat, shadowMapWidth, shadowMapHeight, false)]
-      : null;
-    const depthAttachment = depthFormat
-      ? useTextureArray
-        ? device.pool.fetchTemporalTexture2DArray(false, depthFormat, shadowMapWidth, shadowMapHeight, numCascades, false)
-        : device.type !== 'webgl' && this._light.isPointLight()
-          ? device.pool.fetchTemporalTextureCube(false, depthFormat, shadowMapWidth, false)
-          : device.pool.fetchTemporalTexture2D(false, depthFormat, shadowMapWidth, shadowMapHeight, false)
-      : null;
-    shadowMapParams.shadowMapFramebuffer = device.pool.createTemporalFramebuffer(false, colorAttachments, depthAttachment);
-    if (colorAttachments) {
-      device.pool.releaseTexture(colorAttachments[0]);
-    }
-    if (depthAttachment) {
-      device.pool.releaseTexture(depthAttachment);
-    }
+        /*
+    const colorAttachments = colorFormat
+      ? useTextureArray
+        ? [device.pool.fetchTemporalTexture2DArray(false, colorFormat, shadowMapWidth, shadowMapHeight, numCascades, false)]
+        : this._light.isPointLight()
+          ? [device.pool.fetchTemporalTextureCube(false, colorFormat, shadowMapWidth, false)]
+          : [device.pool.fetchTemporalTexture2D(false, colorFormat, shadowMapWidth, shadowMapHeight, false)]
+      : null;
+    const depthAttachment = depthFormat
+      ? useTextureArray
+        ? device.pool.fetchTemporalTexture2DArray(false, depthFormat, shadowMapWidth, shadowMapHeight, numCascades, false)
+        : device.type !== 'webgl' && this._light.isPointLight()
+          ? device.pool.fetchTemporalTextureCube(false, depthFormat, shadowMapWidth, false)
+          : device.pool.fetchTemporalTexture2D(false, depthFormat, shadowMapWidth, shadowMapHeight, false)
+      : null;
+    shadowMapParams.shadowMapFramebuffer = device.pool.createTemporalFramebuffer(false, colorAttachments, depthAttachment);
+    if (colorAttachments) {
+      device.pool.releaseTexture(colorAttachments[0]);
+    }
+    if (depthAttachment) {
+      device.pool.releaseTexture(depthAttachment);
+    }
     */ shadowMapParams.shadowMapFramebuffer = ShadowMapper.fetchTemporalFramebuffer(true, this._light.lightType, numCascades, shadowMapWidth, shadowMapHeight, colorFormat, depthFormat);
         shadowMapParams.impl = this._impl;
         this._impl.updateResources(shadowMapParams);
@@ -480,14 +555,14 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
         lightCamera.position.setXYZ(0, 0, 0);
         lightCamera.rotation.identity();
         lightCamera.scale.setXYZ(1, 1, 1);
-        lightCamera.setPerspective(Math.PI / 2, 1, this._config.nearClip, Math.min(this._shadowDistance, this._light.range));
+        lightCamera.setPerspective(Math.PI / 2, 1, this._config.nearClip, Math.min(this._shadowDistance, this._light.positionAndRange.w));
         lightCamera.position.set(this._light.positionAndRange.xyz());
     }
     /** @internal */ createLightCameraSpot(lightCamera) {
         this._light.worldMatrix.decompose(null, lightCamera.rotation, lightCamera.position);
         lightCamera.parent = this._light.scene?.rootNode ?? null;
         lightCamera.scale.setXYZ(1, 1, 1);
-        lightCamera.setPerspective(2 * Math.acos(this._light.cutoff), 1, this._config.nearClip, Math.min(this._shadowDistance, this._light.range));
+        lightCamera.setPerspective(2 * Math.acos(this._light.cutoff), 1, this._config.nearClip, Math.min(this._shadowDistance, this._light.positionAndRange.w));
     }
     /** @internal */ createLightCameraRect(lightCamera) {
         const rect = this._light;
@@ -547,68 +622,68 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             center.setXYZ((rx - tx) * 2 / this.shadowMapSize, (ry - ty) * 2 / this.shadowMapSize, 0);
             cropMatrix.translation(center);
         }
-    /*
-    const minx = frustumMin.x;
-    const maxx = frustumMax.x;
-    const miny = frustumMin.y;
-    const maxy = frustumMax.y;
-    const minz = frustumMin.z;
-    const maxz = frustumMax.z;
-    const texelSizeW = (maxx - minx) / this.shadowMapSize;
-    const texelSizeH = (maxy - miny) / this.shadowMapSize;
-    const cx = Math.floor((minx + maxx) / 2 / texelSizeW) * texelSizeW;
-    const cy = Math.floor((miny + maxy) / 2 / texelSizeH) * texelSizeH;
-    const cz = (minz + maxz) / 2;
-    const hx = Math.floor(((maxx - minx) * (expand + 0.5)) / texelSizeW) * texelSizeW;
-    const hy = Math.floor(((maxy - miny) * (expand + 0.5)) / texelSizeH) * texelSizeH;
-    lightCamera.position.setXYZ(cx, cy, cz);
-    lightCamera.setOrtho(
-      -hx,
-      hx,
-      -hy,
-      hy,
-      sceneMax.z - maxz,
-      sceneMax.z - minz + 1
-    );
-    if (cropMatrix) {
-      // compute crop matrix
-      let clipMaxX = 0,
-        clipMaxY = 0;
-      let clipMinX = Number.MAX_VALUE,
-        clipMinY = Number.MAX_VALUE;
-      frustum.corners.forEach((p) => {
-        const clipPos = lightCamera.viewProjectionMatrix.transformPoint(p);
-        clipPos.x = Math.min(1, Math.max(-1, clipPos.x / clipPos.w));
-        clipPos.y = Math.min(1, Math.max(-1, clipPos.y / clipPos.w));
-        if (clipPos.x > clipMaxX) {
-          clipMaxX = clipPos.x;
-        }
-        if (clipPos.x < clipMinX) {
-          clipMinX = clipPos.x;
-        }
-        if (clipPos.y > clipMaxY) {
-          clipMaxY = clipPos.y;
-        }
-        if (clipPos.y < clipMinY) {
-          clipMinY = clipPos.y;
-        }
-      });
-      const clipW = clipMaxX - clipMinX;
-      const clipH = clipMaxY - clipMinY;
-      clipMinX -= expand * clipW;
-      clipMinY -= expand * clipH;
-      clipMaxX += expand * clipW;
-      clipMaxY += expand * clipH;
-      const scaleX = 2 / (clipMaxX - clipMinX);
-      const scaleY = 2 / (clipMaxY - clipMinY);
-      const offsetX = -0.5 * (clipMaxX + clipMinX) * scaleX;
-      const offsetY = -0.5 * (clipMaxY + clipMinY) * scaleY;
-      cropMatrix.identity();
-      cropMatrix.m00 = scaleX;
-      cropMatrix.m11 = scaleY;
-      cropMatrix.m03 = offsetX;
-      cropMatrix.m13 = offsetY;
-    }
+    /*
+    const minx = frustumMin.x;
+    const maxx = frustumMax.x;
+    const miny = frustumMin.y;
+    const maxy = frustumMax.y;
+    const minz = frustumMin.z;
+    const maxz = frustumMax.z;
+    const texelSizeW = (maxx - minx) / this.shadowMapSize;
+    const texelSizeH = (maxy - miny) / this.shadowMapSize;
+    const cx = Math.floor((minx + maxx) / 2 / texelSizeW) * texelSizeW;
+    const cy = Math.floor((miny + maxy) / 2 / texelSizeH) * texelSizeH;
+    const cz = (minz + maxz) / 2;
+    const hx = Math.floor(((maxx - minx) * (expand + 0.5)) / texelSizeW) * texelSizeW;
+    const hy = Math.floor(((maxy - miny) * (expand + 0.5)) / texelSizeH) * texelSizeH;
+    lightCamera.position.setXYZ(cx, cy, cz);
+    lightCamera.setOrtho(
+      -hx,
+      hx,
+      -hy,
+      hy,
+      sceneMax.z - maxz,
+      sceneMax.z - minz + 1
+    );
+    if (cropMatrix) {
+      // compute crop matrix
+      let clipMaxX = 0,
+        clipMaxY = 0;
+      let clipMinX = Number.MAX_VALUE,
+        clipMinY = Number.MAX_VALUE;
+      frustum.corners.forEach((p) => {
+        const clipPos = lightCamera.viewProjectionMatrix.transformPoint(p);
+        clipPos.x = Math.min(1, Math.max(-1, clipPos.x / clipPos.w));
+        clipPos.y = Math.min(1, Math.max(-1, clipPos.y / clipPos.w));
+        if (clipPos.x > clipMaxX) {
+          clipMaxX = clipPos.x;
+        }
+        if (clipPos.x < clipMinX) {
+          clipMinX = clipPos.x;
+        }
+        if (clipPos.y > clipMaxY) {
+          clipMaxY = clipPos.y;
+        }
+        if (clipPos.y < clipMinY) {
+          clipMinY = clipPos.y;
+        }
+      });
+      const clipW = clipMaxX - clipMinX;
+      const clipH = clipMaxY - clipMinY;
+      clipMinX -= expand * clipW;
+      clipMinY -= expand * clipH;
+      clipMaxX += expand * clipW;
+      clipMaxY += expand * clipH;
+      const scaleX = 2 / (clipMaxX - clipMinX);
+      const scaleY = 2 / (clipMaxY - clipMinY);
+      const offsetX = -0.5 * (clipMaxX + clipMinX) * scaleX;
+      const offsetY = -0.5 * (clipMaxY + clipMinY) * scaleY;
+      cropMatrix.identity();
+      cropMatrix.m00 = scaleX;
+      cropMatrix.m11 = scaleY;
+      cropMatrix.m03 = offsetX;
+      cropMatrix.m13 = offsetY;
+    }
     */ }
     /** {@inheritDoc Disposable.onDispose} */ onDispose() {
         this._shadowRegion.dispose();
@@ -816,7 +891,7 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
         this.postRenderShadowMap(shadowMapParams);
     }
     /** @internal */ applyMode(mode) {
-        if (mode !== 'hard' && mode !== 'vsm' && mode !== 'esm' && mode !== 'pcf-pd' && mode !== 'pcf-opt') {
+        if (mode !== 'hard' && mode !== 'vsm' && mode !== 'esm' && mode !== 'pcf' && mode !== 'pcf-pd' && mode !== 'pcf-opt' && mode !== 'pcss') {
             console.error(`ShadowMapper.setShadowMode() failed: invalid mode: ${mode}`);
             return;
         }
@@ -830,10 +905,10 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
             const esm = this._impl;
             esm.blur = this._esmBlur;
             esm.logSpace = this._esmLogSpace;
-        } else if (mode === 'pcf-pd') {
-            this._impl = new PCFPD(this._pdSampleCount, this._pdSampleRadius);
-        } else if (mode === 'pcf-opt') {
+        } else if (mode === 'pcf' || mode === 'pcf-opt' || mode === 'pcf-pd') {
             this._impl = new PCFOPT(this._pcfKernelSize);
+        } else if (mode === 'pcss') {
+            this._impl = new PCSS(this._pcssLightRadius, this._pcssBlockerSampleCount, this._pcssFilterSampleCount, this._pcssMaxFilterRadius, this._pcssTemporalJitter);
         }
     }
     /** @internal */ asVSM() {
@@ -848,6 +923,9 @@ const tmpFrustum = new Frustum(Matrix4x4.identity());
     /** @internal */ asPCFOPT() {
         return this._impl?.getType() === 'pcf-opt' ? this._impl : null;
     }
+    /** @internal */ asPCSS() {
+        return this._impl?.getType() === 'pcss' ? this._impl : null;
+    }
 }
 
 export { ShadowMapper };