babylonjs-editor-tools 5.5.1 → 5.5.2-alpha.0

package/declaration/src/rendering/volumetric/shaders-wgsl.d.ts

@@ -7,6 +7,10 @@ export declare function buildVolumetricLightingLinearDepthShaderWGSL(): string;
  * @param shadowSlotCount defines the number of shadowed light slots the shader is generated for.
  */
 export declare function buildVolumetricLightingScatteringShaderWGSL(shadowSlotCount: number): string;
+/**
+ * The temporal accumulation pass. @see buildVolumetricLightingTemporalShader.
+ */
+export declare function buildVolumetricLightingTemporalShaderWGSL(): string;
 /**
  * The separable bilateral blur pass. @see buildVolumetricLightingBlurShader.
  */
@@ -16,6 +20,6 @@ export declare function buildVolumetricLightingBlurShaderWGSL(): string;
  */
 export declare function buildVolumetricLightingComposeShaderWGSL(): string;
 /**
- * Returns the four WGSL sources of the pipeline, keyed by the name they are registered under.
+ * Returns the WGSL sources of the passes of the pipeline, keyed by the name they are registered under.
  */
 export declare function getVolumetricLightingShadersWGSL(): Record<string, string>;

package/declaration/src/rendering/volumetric/shaders.d.ts

@@ -7,6 +7,10 @@ export declare const volumetricLightingLinearDepthShaderName = "volumetricLighti
  * Defines the name of the raymarching shader in the shader store of Babylon.js.
  */
 export declare const volumetricLightingScatteringShaderName = "volumetricLightingScattering";
+/**
+ * Defines the name of the temporal accumulation shader in the shader store of Babylon.js.
+ */
+export declare const volumetricLightingTemporalShaderName = "volumetricLightingTemporal";
 /**
  * Defines the name of the bilateral blur shader in the shader store of Babylon.js.
  */
@@ -19,8 +23,8 @@ export declare const volumetricLightingComposeShaderName = "volumetricLightingCo
  * The linear depth pass. It is the first pass of the pipeline, so its input is the untouched color of the
  * scene that the composition reads back, and it writes the distance along the view axis of each pixel.
  *
- * Every later pass reads this texture instead of the depth map of the depth source: a single 32 bits
- * channel is half the memory traffic of the 16 bits RGBA depth map, which matters for the thousands of reads
+ * Every later pass reads this texture instead of the depth map of the depth source: a single 16 bits
+ * channel is a fraction of the memory traffic of the RGBA depth map, which matters for the thousands of reads
  * of the depth-buffer occlusion, and it needs neither unpacking nor linearization. It is kept at the full
  * resolution so the occlusion sees the geometry exactly as the surfaces of the scene draw it.
  */
@@ -39,6 +43,16 @@ export declare function buildVolumetricLightingLinearDepthShader(): string;
  * @param shadowSlotCount defines the number of shadowed light slots the shader is generated for.
  */
 export declare function buildVolumetricLightingScatteringShader(shadowSlotCount: number): string;
+/**
+ * The temporal accumulation pass. Blends the scattering of the current frame, whose samples are offset from one
+ * frame to the next, with the scattering accumulated over the previous frames: the result converges to the
+ * integral the samples of all these frames estimate together, which is what lets each frame compute fewer of them.
+ *
+ * The history is reprojected on the current view, and clipped to the range of values the current frame shows
+ * around the pixel so that a moving light, a moving occluder or a surface revealed by the motion of the camera
+ * never leaves a trail. The blend follows the "factor" of the TAA rendering pipeline: the weight of the current frame.
+ */
+export declare function buildVolumetricLightingTemporalShader(): string;
 /**
  * The separable bilateral blur pass. Denoises the low resolution scattering buffer without letting the
  * light shafts bleed across the silhouettes of the geometry.

package/declaration/src/rendering/volumetric/types.d.ts

@@ -21,6 +21,12 @@ export declare const maxVolumetricArrayLights = 256;
  * point and spot lights, a directional light lights the whole view ray, so each one costs a full march.
  */
 export declare const maxVolumetricDirectionalLights = 4;
+/**
+ * Defines by how much the temporal accumulation divides the number of samples the raymarching computes each
+ * frame. The samples of consecutive frames are offset from each other, so the accumulated result still
+ * averages at least as many positions along each view ray as the configured steps.
+ */
+export declare const volumetricTemporalSamplesDivider = 3;
 /**
  * Defines the available step distributions used while raymarching the participating medium.
  */
@@ -168,16 +174,34 @@ export interface IVolumetricLightingConfiguration {
     stepDistribution: VolumetricStepDistribution;
     /**
      * Defines the dithering mode used to hide the banding produced by a low step count. @see VolumetricDitherMode
+     * With the temporal accumulation, "None" falls back on the interleaved gradient noise: the accumulation needs
+     * the samples of neighboring pixels to differ to tell the noise from the changes of the scene.
      */
     ditherMode: VolumetricDitherMode;
     /**
-     * Defines the strength of the dithering applied to the starting offset of the rays.
+     * Defines the strength of the dithering applied to the starting offset of the rays. Not used by the temporal
+     * accumulation, which always spreads the samples over their whole segment.
      */
     ditherStrength: number;
     /**
      * Defines wether or not the dithering pattern is animated over time. Requires temporal anti-aliasing to converge.
+     * Not used by the temporal accumulation, which animates the samples on its own.
      */
     temporalJitter: boolean;
+    /**
+     * Defines wether or not the light shafts are accumulated over the frames. Each frame only computes a fraction
+     * of the samples of the raymarching, offset from one frame to the next, and blends them with the result of the
+     * previous frames reprojected on the current view: the result converges to the quality of the configured
+     * steps, or better, for a fraction of their cost. @see volumetricTemporalSamplesDivider
+     */
+    temporalAccumulation: boolean;
+    /**
+     * Defines the weight of the current frame when it is blended with the accumulated previous frames, like the
+     * "factor" of the TAA rendering pipeline. Lower values average more frames, which gives smoother light shafts,
+     * but make them slower to follow the changes of the scene. The current frame weighs more than this while the
+     * camera moves quickly compared to the distance of what it looks at, so the light shafts never lag behind it.
+     */
+    temporalAccumulationFactor: number;
     /**
      * Defines how the density of the medium evolves with the distance to the camera. @see VolumetricFogMode
      */
@@ -330,6 +354,27 @@ export declare function getDefaultVolumetricLightingConfiguration(): IVolumetric
  * @param configuration defines the configuration of the pipeline.
  */
 export declare function getVolumetricLightSteps(configuration: IVolumetricLightingConfiguration): number;
+/**
+ * Defines the number of samples the raymarching computes for each pixel during a single frame.
+ */
+export interface IVolumetricSamplingSteps {
+    /**
+     * Defines the number of steps of the march of the directional lights, and the minimum density of samples
+     * along the view ray for the point and spot lights.
+     */
+    steps: number;
+    /**
+     * Defines the number of samples taken across the volume of each point and spot light.
+     */
+    lightSteps: number;
+}
+/**
+ * Returns the number of samples the raymarching computes each frame. With the temporal accumulation the
+ * configured values are divided, the history of the previous frames providing the samples each frame skips.
+ * @param configuration defines the configuration of the pipeline.
+ * @param temporalSamplesDivider defines by how much the temporal accumulation divides the number of samples.
+ */
+export declare function getVolumetricSamplingSteps(configuration: IVolumetricLightingConfiguration, temporalSamplesDivider?: number): IVolumetricSamplingSteps;
 /**
  * Normalizes the given serialized per-light volumetric configuration by merging it over the default one.
  * This is what makes projects saved by an older version of the editor load without any migration step.

package/declaration/src/rendering/volumetric-lighting.d.ts

@@ -1,7 +1,7 @@
 import { Scene } from "@babylonjs/core/scene";
 import { Camera } from "@babylonjs/core/Cameras/camera";
-import { VolumetricLightingRenderingPipeline } from "./volumetric/pipeline";
 import { IRenderingOptions } from "./tools";
+import { VolumetricLightingRenderingPipeline } from "./volumetric/pipeline";
 export declare function getVolumetricLightingRenderingPipelineConfiguration(): any;
 export declare function setVolumetricLightingRenderingPipelineConfiguration(config: any): void;
 export declare function getVolumetricLightingRenderingPipeline(): VolumetricLightingRenderingPipeline | null;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "babylonjs-editor-tools",
-	"version": "5.5.1",
+	"version": "5.5.2-alpha.0",
 	"description": "Babylon.js Editor Tools is a set of tools to help you create, edit and manage your Babylon.js scenes made using the Babylon.js Editor",
 	"productName": "Babylon.js Editor Tools",
 	"scripts": {