@woosh/meep-engine 3.60.3 → 3.60.5

package/src/shade/renderer/atmosphere/chunk_get_multiscatter_values.js

@@ -1,163 +1,162 @@
-import { ATMOSPHERE_RADII_DECLARATION } from "../shader/chunk/atmosphere/ATMOSPHERE_RADII_DECLARATION.js";
-import {
-    C_MIE_ABSORPTION_DECLARATION,
-    C_MIE_SCATTERING_DECLARATION
-} from "../shader/chunk/atmosphere/C_MIE_SCATTERING_DECLARATION.js";
-import { C_OZONE_DECLARATION } from "../shader/chunk/atmosphere/C_OZONE_DECLARATION.js";
-import { C_RAYLEIGH_DECLARATION } from "../shader/chunk/atmosphere/C_RAYLEIGH_DECLARATION.js";
-import { chunk_atmosphere_density } from "../shader/chunk/atmosphere/chunk_atmosphere_density.js";
-import { chunk_atmosphere_ray_bounds } from "../shader/chunk/atmosphere/chunk_atmosphere_ray_bounds.js";
-import {
-    chunk_position_relative_to_planet_center
-} from "../shader/chunk/atmosphere/chunk_position_relative_to_planet_center.js";
-import {
-    chunk_phase_mie_cornette_shanks
-} from "../shader/chunk/atmosphere/phase/chunk_phase_mie_cornette_shanks.js";
-import { chunk_phase_rayleigh } from "../shader/chunk/atmosphere/phase/chunk_phase_rayleigh.js";
-import { PI_DECLARATION } from "../shader/chunk/math/PI_DECLARATION.js";
-import { CodeChunk } from "../shader/compiler/CodeChunk.js";
-import { chunk_sample_transmittance_lut_params } from "./chunk_sample_transmittance_lut.js";
-import { MIE_G } from "./MIE_G.js";
-import { MULTISCATTER_LUT_STEPS } from "./MULTISCATTER_LUT_CONFIG.js";
-
-
-/**
- * One direction's contribution to Equations (5) and (7) from the paper: `out_lum` is the
- * second-order in-scattered luminance along `rayDir`, `out_fms` the luminance that would
- * come back if the medium scattered one unit of light isotropically. The caller integrates
- * over the direction set -- see {@link chunk_multiscatter_sample_direction} -- by taking the
- * mean, which is what the paper's uniform phase p_u = 1/(4*PI) reduces to.
- *
- * Splitting one direction out of the loop is what lets `shader_multiscatter_lut` put a
- * thread on each of the 64 directions, the way Hillaire's `NewMultiScattCS` does.
- *
- * `pos` is assumed to be inside the atmosphere and at or above the surface, which is what
- * makes the far root of the outer sphere the atmosphere exit.
- *
- * @see "A Scalable and Production Ready Sky and Atmosphere Rendering Technique", Hillaire (2020)
- * @see https://www.shadertoy.com/view/slSXRW
- * @type {CodeChunk}
- */
-export const chunk_get_multiscatter_values = CodeChunk.from(
-    //language=WGSL
-    `
-const MULTISCATTER_GROUND_ALBEDO = vec3(0.3);
-const MULTISCATTER_STEPS = ${MULTISCATTER_LUT_STEPS}u;
-const MULTISCATTER_STEPS_F = f32(MULTISCATTER_STEPS);
-
-fn get_multiscatter_values(
-    pos: vec3<f32>,
-    sunDir: vec3<f32>,
-    rayDir: vec3<f32>,
-    out_lum: ptr<function,vec3<f32>>,
-    out_fms: ptr<function,vec3<f32>>,
-) {
-    let rel = position_relative_to_planet_center(pos);
-
-    // one quadratic setup for both spheres; in case we're looking down, the ground is as far
-    // as the march goes
-    let bounds = atmosphere_ray_bounds(rel, rayDir);
-
-    let tMax = bounds.t_max;
-
-    let cosTheta = dot(rayDir, sunDir);
-
-    let miePhaseValue = phase_mie(cosTheta, ${MIE_G});
-    let rayleighPhaseValue = phase_rayleigh(-cosTheta);
-
-    var lum = vec3(0.0);
-    var lumFactor = vec3(0.0);
-    var transmittance = vec3(1.0);
-
-    var t = 0.0;
-    for (var stepI = 0u; stepI < MULTISCATTER_STEPS; stepI++) {
-        let newT = ( (f32(stepI) + 0.3) / MULTISCATTER_STEPS_F ) * tMax;
-        let dt = newT - t;
-        t = newT;
-
-        // Stepping the planet-relative position directly: building the world position only
-        // to have the LUT lookup subtract the planet centre back off it was the second of
-        // two square roots per step.
-        let step_rel = rel + t * rayDir;
-        let step_radius = length(step_rel);
-        let up = step_rel / step_radius;
-
-        let local_height = step_radius - ATMOSPHERE_GROUND_RADIUS;
-        let local_density = atmosphere_density(local_height);
-
-        let ozone_density = local_density.z;
-        let ozone_absorption =  ozone_density * C_OZONE;
-
-        let mie_density = local_density.y;
-        let mie_absorption = mie_density * C_MIE_ABSORPTION;
-        let mie_scattering = mie_density * C_MIE_SCATTERING;
-
-        // note - taken from the Hillaire's atmosphere code: https://github.com/sebh/UnrealEngineSkyAtmosphere/blob/183ead5bdacc701b3b626347a680a2f3cd3d4fbd/Resources/RenderSkyCommon.hlsl#L248
-        let rayleigh_absorption = 0.0;
-        let rayleigh_scattering = local_density.x * C_RAYLEIGH;
-
-        let extinction = rayleigh_scattering + rayleigh_absorption + mie_scattering + mie_absorption + ozone_absorption;
-
-
-        let sample_transmittance = exp(-dt * extinction);
-
-        // Integrate within each segment.
-        let scatteringNoPhase = rayleigh_scattering + mie_scattering;
-        let scatteringF = (scatteringNoPhase - scatteringNoPhase * sample_transmittance) / extinction;
-        lumFactor += transmittance * scatteringF;
-
-        // This is slightly different from the paper, but I think the paper has a mistake?
-        // In equation (6), I think S(x,w_s) should be S(x-tv,w_s).
-        let sun_transmittance = sample_transmittance_lut_params(local_height, dot(sunDir, up));
-
-        let rayleighInScattering = rayleigh_scattering * rayleighPhaseValue;
-        let mieInScattering = mie_scattering * miePhaseValue;
-        let inScattering = (rayleighInScattering + mieInScattering) * sun_transmittance;
-
-        // Integrated scattering within path segment.
-        let scatteringIntegral = (inScattering - inScattering * sample_transmittance) / extinction;
-
-        lum += scatteringIntegral * transmittance;
-        transmittance *= sample_transmittance;
-    }
-
-    if (bounds.hits_ground) {
-
-        // Light bounced off the planet. Hillaire reaches this through
-        // IntegrateScatteredLuminance:
-        //     L += ... * throughput * NdotL * Atmosphere.GroundAlbedo / PI
-        // The surface is Lambertian, hence albedo/PI, and the cosine belongs to the hit
-        // point rather than to \`pos\`: along a shallow ray the two are hundreds of
-        // kilometres apart and can sit on opposite sides of the terminator.
-        let hit_up = normalize(rel + bounds.ground_distance * rayDir);
-
-        let sun_cos_zenith_angle = dot(hit_up, sunDir);
-
-        // the hit lies on the surface by construction, so its LUT altitude is exactly zero
-        let sun_transmittance = sample_transmittance_lut_params(0.0, sun_cos_zenith_angle);
-
-        lum += transmittance
-            * saturate(sun_cos_zenith_angle)
-            * (MULTISCATTER_GROUND_ALBEDO / PI)
-            * sun_transmittance;
-    }
-
-    *out_fms = lumFactor;
-    *out_lum = lum;
-
-}
-    `, [
-        PI_DECLARATION,
-        ATMOSPHERE_RADII_DECLARATION,
-        C_OZONE_DECLARATION,
-        C_MIE_SCATTERING_DECLARATION,
-        C_MIE_ABSORPTION_DECLARATION,
-        C_RAYLEIGH_DECLARATION,
-        chunk_atmosphere_density,
-        chunk_atmosphere_ray_bounds,
-        chunk_phase_mie_cornette_shanks,
-        chunk_phase_rayleigh,
-        chunk_position_relative_to_planet_center,
-        chunk_sample_transmittance_lut_params,
-    ]
-)
+import { ATMOSPHERE_RADII_DECLARATION } from "../shader/chunk/atmosphere/ATMOSPHERE_RADII_DECLARATION.js";
+import {
+    C_MIE_ABSORPTION_DECLARATION,
+    C_MIE_SCATTERING_DECLARATION
+} from "../shader/chunk/atmosphere/C_MIE_SCATTERING_DECLARATION.js";
+import { C_OZONE_DECLARATION } from "../shader/chunk/atmosphere/C_OZONE_DECLARATION.js";
+import { C_RAYLEIGH_DECLARATION } from "../shader/chunk/atmosphere/C_RAYLEIGH_DECLARATION.js";
+import { chunk_atmosphere_density } from "../shader/chunk/atmosphere/chunk_atmosphere_density.js";
+import { chunk_atmosphere_ray_bounds } from "../shader/chunk/atmosphere/chunk_atmosphere_ray_bounds.js";
+import {
+    chunk_position_relative_to_planet_center
+} from "../shader/chunk/atmosphere/chunk_position_relative_to_planet_center.js";
+import {
+    chunk_phase_mie_cornette_shanks
+} from "../shader/chunk/atmosphere/phase/chunk_phase_mie_cornette_shanks.js";
+import { chunk_phase_rayleigh } from "../shader/chunk/atmosphere/phase/chunk_phase_rayleigh.js";
+import { PI_DECLARATION } from "../shader/chunk/math/PI_DECLARATION.js";
+import { CodeChunk } from "../shader/compiler/CodeChunk.js";
+import { chunk_sample_transmittance_lut_params } from "./chunk_sample_transmittance_lut.js";
+import { MIE_G } from "./MIE_G.js";
+import { MULTISCATTER_LUT_STEPS } from "./MULTISCATTER_LUT_CONFIG.js";
+
+
+/**
+ * One direction's contribution to Equations (5) and (7) from the paper: `out_lum` is the
+ * second-order in-scattered luminance along `rayDir`, `out_fms` the luminance that would
+ * come back if the medium scattered one unit of light isotropically. The caller integrates
+ * over the direction set -- see {@link chunk_multiscatter_sample_direction} -- by taking the
+ * mean, which is what the paper's uniform phase p_u = 1/(4*PI) reduces to.
+ *
+ * Splitting one direction out of the loop is what lets `shader_multiscatter_lut` put a
+ * thread on each of the 64 directions.
+ *
+ * `pos` is assumed to be inside the atmosphere and at or above the surface, which is what
+ * makes the far root of the outer sphere the atmosphere exit.
+ *
+ * @see "A Scalable and Production Ready Sky and Atmosphere Rendering Technique", Hillaire (2020)
+ * @see https://www.shadertoy.com/view/slSXRW
+ * @type {CodeChunk}
+ */
+export const chunk_get_multiscatter_values = CodeChunk.from(
+    //language=WGSL
+    `
+const MULTISCATTER_GROUND_ALBEDO = vec3(0.3);
+const MULTISCATTER_STEPS = ${MULTISCATTER_LUT_STEPS}u;
+const MULTISCATTER_STEPS_F = f32(MULTISCATTER_STEPS);
+
+fn get_multiscatter_values(
+    pos: vec3<f32>,
+    sunDir: vec3<f32>,
+    rayDir: vec3<f32>,
+    out_lum: ptr<function,vec3<f32>>,
+    out_fms: ptr<function,vec3<f32>>,
+) {
+    let rel = position_relative_to_planet_center(pos);
+
+    // one quadratic setup for both spheres; in case we're looking down, the ground is as far
+    // as the march goes
+    let bounds = atmosphere_ray_bounds(rel, rayDir);
+
+    let tMax = bounds.t_max;
+
+    let cosTheta = dot(rayDir, sunDir);
+
+    let miePhaseValue = phase_mie(cosTheta, ${MIE_G});
+    let rayleighPhaseValue = phase_rayleigh(-cosTheta);
+
+    var lum = vec3(0.0);
+    var lumFactor = vec3(0.0);
+    var transmittance = vec3(1.0);
+
+    var t = 0.0;
+    for (var stepI = 0u; stepI < MULTISCATTER_STEPS; stepI++) {
+        let newT = ( (f32(stepI) + 0.3) / MULTISCATTER_STEPS_F ) * tMax;
+        let dt = newT - t;
+        t = newT;
+
+        // Stepping the planet-relative position directly: building the world position only
+        // to have the LUT lookup subtract the planet centre back off it was the second of
+        // two square roots per step.
+        let step_rel = rel + t * rayDir;
+        let step_radius = length(step_rel);
+        let up = step_rel / step_radius;
+
+        let local_height = step_radius - ATMOSPHERE_GROUND_RADIUS;
+        let local_density = atmosphere_density(local_height);
+
+        let ozone_density = local_density.z;
+        let ozone_absorption =  ozone_density * C_OZONE;
+
+        let mie_density = local_density.y;
+        let mie_absorption = mie_density * C_MIE_ABSORPTION;
+        let mie_scattering = mie_density * C_MIE_SCATTERING;
+
+        let rayleigh_absorption = 0.0;
+        let rayleigh_scattering = local_density.x * C_RAYLEIGH;
+
+        let extinction = rayleigh_scattering + rayleigh_absorption + mie_scattering + mie_absorption + ozone_absorption;
+
+
+        let sample_transmittance = exp(-dt * extinction);
+
+        // Integrate within each segment.
+        let scatteringNoPhase = rayleigh_scattering + mie_scattering;
+        let scatteringF = (scatteringNoPhase - scatteringNoPhase * sample_transmittance) / extinction;
+        lumFactor += transmittance * scatteringF;
+
+        // This is slightly different from the paper, but I think the paper has a mistake?
+        // In equation (6), I think S(x,w_s) should be S(x-tv,w_s).
+        let sun_transmittance = sample_transmittance_lut_params(local_height, dot(sunDir, up));
+
+        let rayleighInScattering = rayleigh_scattering * rayleighPhaseValue;
+        let mieInScattering = mie_scattering * miePhaseValue;
+        let inScattering = (rayleighInScattering + mieInScattering) * sun_transmittance;
+
+        // Integrated scattering within path segment.
+        let scatteringIntegral = (inScattering - inScattering * sample_transmittance) / extinction;
+
+        lum += scatteringIntegral * transmittance;
+        transmittance *= sample_transmittance;
+    }
+
+    if (bounds.hits_ground) {
+
+        // Light bounced off the planet. Hillaire reaches this through
+        // IntegrateScatteredLuminance:
+        //     L += ... * throughput * NdotL * Atmosphere.GroundAlbedo / PI
+        // The surface is Lambertian, hence albedo/PI, and the cosine belongs to the hit
+        // point rather than to \`pos\`: along a shallow ray the two are hundreds of
+        // kilometres apart and can sit on opposite sides of the terminator.
+        let hit_up = normalize(rel + bounds.ground_distance * rayDir);
+
+        let sun_cos_zenith_angle = dot(hit_up, sunDir);
+
+        // the hit lies on the surface by construction, so its LUT altitude is exactly zero
+        let sun_transmittance = sample_transmittance_lut_params(0.0, sun_cos_zenith_angle);
+
+        lum += transmittance
+            * saturate(sun_cos_zenith_angle)
+            * (MULTISCATTER_GROUND_ALBEDO / PI)
+            * sun_transmittance;
+    }
+
+    *out_fms = lumFactor;
+    *out_lum = lum;
+
+}
+    `, [
+        PI_DECLARATION,
+        ATMOSPHERE_RADII_DECLARATION,
+        C_OZONE_DECLARATION,
+        C_MIE_SCATTERING_DECLARATION,
+        C_MIE_ABSORPTION_DECLARATION,
+        C_RAYLEIGH_DECLARATION,
+        chunk_atmosphere_density,
+        chunk_atmosphere_ray_bounds,
+        chunk_phase_mie_cornette_shanks,
+        chunk_phase_rayleigh,
+        chunk_position_relative_to_planet_center,
+        chunk_sample_transmittance_lut_params,
+    ]
+)

package/src/shade/renderer/atmosphere/compute_mie_absorption.d.ts

@@ -1,5 +1,5 @@
 /**
- * @see https://github.com/sebh/UnrealEngineSkyAtmosphere/blob/183ead5bdacc701b3b626347a680a2f3cd3d4fbd/Application/Game.cpp#L707
+ * Compute Mie absorption from scattering and extinction coefficients.
  * @param {number[]} scattering
  * @param {number[]} extinction
  * @returns {number[]}

package/src/shade/renderer/atmosphere/compute_mie_absorption.js

@@ -1,5 +1,5 @@
 /**
- * @see https://github.com/sebh/UnrealEngineSkyAtmosphere/blob/183ead5bdacc701b3b626347a680a2f3cd3d4fbd/Application/Game.cpp#L707
+ * Compute Mie absorption from scattering and extinction coefficients.
  * @param {number[]} scattering
  * @param {number[]} extinction
  * @returns {number[]}

package/src/shade/renderer/atmosphere/hillaire/ATMOSPHERE_EARTH.js

@@ -10,7 +10,7 @@ import { compute_mie_absorption } from "../compute_mie_absorption.js";
  * Earth-like atmospheric parametrization
  *
  * NOTE: all values are in Km (not m)
- * @see https://github.com/sebh/UnrealEngineSkyAtmosphere/blob/183ead5bdacc701b3b626347a680a2f3cd3d4fbd/Application/SkyAtmosphereCommon.cpp#L11
+ * @see "A Scalable and Production Ready Sky and Atmosphere Rendering Technique", Hillaire (2020)
  */
 export const ATMOSPHERE_EARTH = {
     BottomRadius: 6378,

package/src/shade/renderer/atmosphere/hillaire/ATMOSPHERE_PARAMETERS_STRUCT.js

@@ -2,7 +2,7 @@ import { f32, vec3f } from "../../shader/type/WEBGPU_WGSL_PRIMITIVE_TYPES.js";
 import { WebGPUStruct } from "../../shader/type/WebGPUStruct.js";
 
 /**
- * @see https://github.com/sebh/UnrealEngineSkyAtmosphere/blob/183ead5bdacc701b3b626347a680a2f3cd3d4fbd/Resources/SkyAtmosphereCommon.hlsl#L81
+ * Atmosphere parameters uniform struct ("A Scalable and Production Ready Sky and Atmosphere Rendering Technique", Hillaire 2020).
  * @type {WebGPUStruct}
  */
 const ATMOSPHERE_PARAMETERS_STRUCT = WebGPUStruct.from({