@zephyr3d/scene 0.9.26 → 0.9.27

package/dist/camera/camera.js

@@ -124,6 +124,7 @@ const SSS_QUALITY_PRESET_SETTINGS = {
     /** @internal Render path selection for scene renderer. */ _renderPath;
     /** @internal Whether command buffers may be reused for optimization. */ _commandBufferReuse;
     /** @internal Hi-Z acceleration enable (primarily for SSR). */ _HiZ;
+    _HiZNearest;
     /** @internal Screen-space shadow mask enable (Forward+ deferred shadows). */ _screenSpaceShadowMask;
     /** @internal If true, a float point backbuffer will be used. The default value is true */ _HDR;
     /** @internal Tonemap enable flag (via post effect). */ _toneMap;
@@ -137,6 +138,8 @@ const SSS_QUALITY_PRESET_SETTINGS = {
     /** @internal Motion blur enable flag (via post effect). */ _motionBlur;
     /** @internal Motion blur post effect reference. */ _postEffectMotionBlur;
     /** @internal Motion blur strength. */ _motionBlurStrength;
+    /** @internal Motion blur shutter bias. */ _motionBlurShutterBias;
+    /** @internal Motion blur maximum streak length in pixels. */ _motionBlurMaxLength;
     /** @internal Bloom enable flag (via post effect). */ _bloom;
     /** @internal Bloom post effect reference. */ _postEffectBloom;
     /** @internal Bloom downsample level cap. */ _bloomMaxDownsampleLevels;
@@ -212,10 +215,9 @@ const SSS_QUALITY_PRESET_SETTINGS = {
     _skinSSSScatterTint;
     /** @internal SSAO enable flag (via post effect). */ _SSAO;
     /** @internal SSAO post effect reference. */ _postEffectSSAO;
-    /** @internal SSAO scale (sampling radius multiplier). */ _SSAOScale;
+    /** @internal SSAO scale (sampling radius multiplier). */ _SSAOOcclusionRadius;
     /** @internal SSAO bias (self-shadowing reduction). */ _SSAOBias;
-    /** @internal SSAO sample radius. */ _SSAORadius;
-    /** @internal SSAO intensity. */ _SSAOIntensity;
+    /** @internal SSAO sample radius. */ /** @internal SSAO intensity. */ _SSAOIntensity;
     /** @internal SSAO blur depth cutoff. */ _SSAOBlurDepthCutoff;
     /** @internal Pending GPU-pick promise (one-shot). */ _pickResultPromise;
     /** @internal Resolver for the pending pick promise. */ _pickResultResolve;
@@ -270,6 +272,7 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         this._screenAdapter = new ScreenAdapter();
         this._adapted = false;
         this._HiZ = false;
+        this._HiZNearest = false;
         this._screenSpaceShadowMask = true;
         this._HDR = true;
         this._toneMap = true;
@@ -283,6 +286,8 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         this._motionBlur = false;
         this._postEffectMotionBlur = new DRef();
         this._motionBlurStrength = 1;
+        this._motionBlurShutterBias = 0.5;
+        this._motionBlurMaxLength = 40;
         this._bloom = false;
         this._postEffectBloom = new DRef();
         this._bloomMaxDownsampleLevels = 4;
@@ -369,10 +374,9 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         this._skinSSSScatterTint = new Vector4(1, 1, 1, 1);
         this._SSAO = false;
         this._postEffectSSAO = new DRef();
-        this._SSAOScale = 10;
-        this._SSAOBias = 1;
-        this._SSAOIntensity = 0.025;
-        this._SSAORadius = 100;
+        this._SSAOOcclusionRadius = 0.25;
+        this._SSAOBias = 0.05;
+        this._SSAOIntensity = 1;
         this._SSAOBlurDepthCutoff = 2;
         this._pickResult = null;
         this._commandBufferReuse = true;
@@ -443,6 +447,24 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         this._HiZ = !!val;
     }
     /**
+   * Whether the Hi-Z pyramid carries its nearest-depth channel.
+   *
+   * The pyramid's own channel answers "what is the farthest thing in this screen
+   * region", which is what occlusion and ray marching want; this one answers
+   * "what is the nearest", which is what a proximity query wants. It doubles the
+   * pyramid's bandwidth, so it is off unless something asks for it.
+   *
+   * Materials that query it - water's shoreline foam - turn it on by themselves,
+   * the way a transmissive material turns on the scene colour copy, so this only
+   * has to be set to force the channel on for something the renderer cannot see
+   * coming. Ignored on WebGL1, which has no pyramid at all.
+   */ get HiZNearest() {
+        return this._HiZNearest;
+    }
+    set HiZNearest(val) {
+        this._HiZNearest = !!val;
+    }
+    /**
    * Whether the screen-space shadow mask is enabled.
    *
    * When enabled, shadow-casting lights are lit through the clustered pass and
@@ -499,6 +521,38 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         }
     }
     /**
+   * How much of the motion blur streak lies ahead of where an object is now,
+   * as a fraction of its length. 0 trails the streak fully behind the object,
+   * 0.5 (the default) centres it. See {@link MotionBlur.shutterBias}.
+   */ get motionBlurShutterBias() {
+        return this._motionBlurShutterBias;
+    }
+    set motionBlurShutterBias(val) {
+        this._motionBlurShutterBias = val;
+        if (this._postEffectMotionBlur.get()) {
+            this._postEffectMotionBlur.get().shutterBias = val;
+            // The effect clamps; read it back so the camera and the effect cannot
+            // disagree about what was actually applied.
+            this._motionBlurShutterBias = this._postEffectMotionBlur.get().shutterBias;
+        }
+    }
+    /**
+   * Longest motion blur streak, in pixels at render resolution. This is the
+   * ceiling {@link Camera.motionBlurStrength} runs into; raising it costs
+   * samples in proportion. See {@link MotionBlur.maxBlurLength}.
+   */ get motionBlurMaxLength() {
+        return this._motionBlurMaxLength;
+    }
+    set motionBlurMaxLength(val) {
+        this._motionBlurMaxLength = val;
+        if (this._postEffectMotionBlur.get()) {
+            this._postEffectMotionBlur.get().maxBlurLength = val;
+            // The effect clamps; read it back so the camera and the effect cannot
+            // disagree about what was actually applied.
+            this._motionBlurMaxLength = this._postEffectMotionBlur.get().maxBlurLength;
+        }
+    }
+    /**
    * Gets whether Bloom is enabled.
    */ get bloom() {
         return this._postEffectBloom.get().enabled;
@@ -1242,13 +1296,19 @@ const SSS_QUALITY_PRESET_SETTINGS = {
     set SSAO(val) {
         this._postEffectSSAO.get().enabled = !!val;
     }
-    /** SSAO scale */ get SSAOScale() {
-        return this._SSAOScale;
+    /**
+   * SSAO occlusion radius, in world units (metres).
+   *
+   * @remarks
+   * Replaces the old `SSAOScale`, which was a far-plane-relative multiplier and
+   * carried no physical meaning.
+   */ get SSAOOcclusionRadius() {
+        return this._SSAOOcclusionRadius;
     }
-    set SSAOScale(val) {
-        this._SSAOScale = val;
+    set SSAOOcclusionRadius(val) {
+        this._SSAOOcclusionRadius = val;
         if (this._postEffectSSAO.get()) {
-            this._postEffectSSAO.get().scale = val;
+            this._postEffectSSAO.get().occlusionRadius = val;
         }
     }
     /** SSAO bias */ get SSAOBias() {
@@ -1260,15 +1320,6 @@ const SSS_QUALITY_PRESET_SETTINGS = {
             this._postEffectSSAO.get().bias = val;
         }
     }
-    /** SSAO radius */ get SSAORadius() {
-        return this._SSAORadius;
-    }
-    set SSAORadius(val) {
-        this._SSAORadius = val;
-        if (this._postEffectSSAO.get()) {
-            this._postEffectSSAO.get().radius = val;
-        }
-    }
     /** SSAO intensity */ get SSAOIntensity() {
         return this._SSAOIntensity;
     }
@@ -1708,9 +1759,8 @@ const SSS_QUALITY_PRESET_SETTINGS = {
         if (!this._postEffectSSAO.get()) {
             const ssao = new SAO();
             ssao.enabled = false;
-            ssao.scale = this._SSAOScale;
+            ssao.occlusionRadius = this._SSAOOcclusionRadius;
             ssao.bias = this._SSAOBias;
-            ssao.radius = this._SSAORadius;
             ssao.intensity = this._SSAOIntensity;
             ssao.blurDepthCutoff = this._SSAOBlurDepthCutoff;
             this._postEffectSSAO.set(ssao);
@@ -1742,6 +1792,8 @@ const SSS_QUALITY_PRESET_SETTINGS = {
             const motionBlur = new MotionBlur();
             motionBlur.enabled = false;
             motionBlur.strength = this._motionBlurStrength;
+            motionBlur.shutterBias = this._motionBlurShutterBias;
+            motionBlur.maxBlurLength = this._motionBlurMaxLength;
             this._postEffectMotionBlur.set(motionBlur);
             this._compositor.appendPostEffect(motionBlur);
         }