@cesium/engine 6.2.0 → 7.0.0

package/Source/Shaders/Builtin/Functions/approximateTanh.js

@@ -0,0 +1,12 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "/**\n\
+ * Compute a rational approximation to tanh(x)\n\
+ *\n\
+ * @param {float} x A real number input\n\
+ * @returns {float} An approximation for tanh(x)\n\
+*/\n\
+float czm_approximateTanh(float x) {\n\
+    float x2 = x * x;\n\
+    return max(-1.0, min(1.0, x * (27.0 + x2) / (27.0 + 9.0 * x2)));\n\
+}\n\
+";

package/Source/Shaders/Builtin/Functions/computeAtmosphereColor.glsl

@@ -0,0 +1,44 @@
+/**
+ * Compute the atmosphere color, applying Rayleigh and Mie scattering. This
+ * builtin uses automatic uniforms so the atmophere settings are synced with the
+ * state of the Scene, even in other contexts like Model.
+ *
+ * @name czm_computeAtmosphereColor
+ * @glslFunction
+ *
+ * @param {vec3} positionWC Position of the fragment in world coords (low precision)
+ * @param {vec3} lightDirection Light direction from the sun or other light source.
+ * @param {vec3} rayleighColor The Rayleigh scattering color computed by a scattering function
+ * @param {vec3} mieColor The Mie scattering color computed by a scattering function
+ * @param {float} opacity The opacity computed by a scattering function.
+ */
+vec4 czm_computeAtmosphereColor(
+    vec3 positionWC,
+    vec3 lightDirection,
+    vec3 rayleighColor,
+    vec3 mieColor,
+    float opacity
+) {
+    // Setup the primary ray: from the camera position to the vertex position.
+    vec3 cameraToPositionWC = positionWC - czm_viewerPositionWC;
+    vec3 cameraToPositionWCDirection = normalize(cameraToPositionWC);
+
+    float cosAngle = dot(cameraToPositionWCDirection, lightDirection);
+    float cosAngleSq = cosAngle * cosAngle;
+
+    float G = czm_atmosphereMieAnisotropy;
+    float GSq = G * G;
+
+    // The Rayleigh phase function.
+    float rayleighPhase = 3.0 / (50.2654824574) * (1.0 + cosAngleSq);
+    // The Mie phase function.
+    float miePhase = 3.0 / (25.1327412287) * ((1.0 - GSq) * (cosAngleSq + 1.0)) / (pow(1.0 + GSq - 2.0 * cosAngle * G, 1.5) * (2.0 + GSq));
+
+    // The final color is generated by combining the effects of the Rayleigh and Mie scattering.
+    vec3 rayleigh = rayleighPhase * rayleighColor;
+    vec3 mie = miePhase * mieColor;
+
+    vec3 color = (rayleigh + mie) * czm_atmosphereLightIntensity;
+
+    return vec4(color, opacity);
+}

package/Source/Shaders/Builtin/Functions/computeAtmosphereColor.js

@@ -0,0 +1,46 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "/**\n\
+ * Compute the atmosphere color, applying Rayleigh and Mie scattering. This\n\
+ * builtin uses automatic uniforms so the atmophere settings are synced with the\n\
+ * state of the Scene, even in other contexts like Model.\n\
+ *\n\
+ * @name czm_computeAtmosphereColor\n\
+ * @glslFunction\n\
+ *\n\
+ * @param {vec3} positionWC Position of the fragment in world coords (low precision)\n\
+ * @param {vec3} lightDirection Light direction from the sun or other light source.\n\
+ * @param {vec3} rayleighColor The Rayleigh scattering color computed by a scattering function\n\
+ * @param {vec3} mieColor The Mie scattering color computed by a scattering function\n\
+ * @param {float} opacity The opacity computed by a scattering function.\n\
+ */\n\
+vec4 czm_computeAtmosphereColor(\n\
+    vec3 positionWC,\n\
+    vec3 lightDirection,\n\
+    vec3 rayleighColor,\n\
+    vec3 mieColor,\n\
+    float opacity\n\
+) {\n\
+    // Setup the primary ray: from the camera position to the vertex position.\n\
+    vec3 cameraToPositionWC = positionWC - czm_viewerPositionWC;\n\
+    vec3 cameraToPositionWCDirection = normalize(cameraToPositionWC);\n\
+\n\
+    float cosAngle = dot(cameraToPositionWCDirection, lightDirection);\n\
+    float cosAngleSq = cosAngle * cosAngle;\n\
+\n\
+    float G = czm_atmosphereMieAnisotropy;\n\
+    float GSq = G * G;\n\
+\n\
+    // The Rayleigh phase function.\n\
+    float rayleighPhase = 3.0 / (50.2654824574) * (1.0 + cosAngleSq);\n\
+    // The Mie phase function.\n\
+    float miePhase = 3.0 / (25.1327412287) * ((1.0 - GSq) * (cosAngleSq + 1.0)) / (pow(1.0 + GSq - 2.0 * cosAngle * G, 1.5) * (2.0 + GSq));\n\
+\n\
+    // The final color is generated by combining the effects of the Rayleigh and Mie scattering.\n\
+    vec3 rayleigh = rayleighPhase * rayleighColor;\n\
+    vec3 mie = miePhase * mieColor;\n\
+\n\
+    vec3 color = (rayleigh + mie) * czm_atmosphereLightIntensity;\n\
+\n\
+    return vec4(color, opacity);\n\
+}\n\
+";

package/Source/Shaders/Builtin/Functions/computeGroundAtmosphereScattering.glsl

@@ -0,0 +1,30 @@
+/**
+ * Compute atmosphere scattering for the ground atmosphere and fog. This method
+ * uses automatic uniforms so it is always synced with the scene settings.
+ *
+ * @name czm_computeGroundAtmosphereScattering
+ * @glslfunction
+ *
+ * @param {vec3} positionWC The position of the fragment in world coordinates.
+ * @param {vec3} lightDirection The direction of the light to calculate the scattering from.
+ * @param {vec3} rayleighColor The variable the Rayleigh scattering will be written to.
+ * @param {vec3} mieColor The variable the Mie scattering will be written to.
+ * @param {float} opacity The variable the transmittance will be written to.
+ */
+void czm_computeGroundAtmosphereScattering(vec3 positionWC, vec3 lightDirection, out vec3 rayleighColor, out vec3 mieColor, out float opacity) {
+    vec3 cameraToPositionWC = positionWC - czm_viewerPositionWC;
+    vec3 cameraToPositionWCDirection = normalize(cameraToPositionWC);
+    czm_ray primaryRay = czm_ray(czm_viewerPositionWC, cameraToPositionWCDirection);
+
+    float atmosphereInnerRadius = length(positionWC);
+
+    czm_computeScattering(
+        primaryRay,
+        length(cameraToPositionWC),
+        lightDirection,
+        atmosphereInnerRadius,
+        rayleighColor,
+        mieColor,
+        opacity
+    );
+}

package/Source/Shaders/Builtin/Functions/computeGroundAtmosphereScattering.js

@@ -0,0 +1,32 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "/**\n\
+ * Compute atmosphere scattering for the ground atmosphere and fog. This method\n\
+ * uses automatic uniforms so it is always synced with the scene settings.\n\
+ *\n\
+ * @name czm_computeGroundAtmosphereScattering\n\
+ * @glslfunction\n\
+ *\n\
+ * @param {vec3} positionWC The position of the fragment in world coordinates.\n\
+ * @param {vec3} lightDirection The direction of the light to calculate the scattering from.\n\
+ * @param {vec3} rayleighColor The variable the Rayleigh scattering will be written to.\n\
+ * @param {vec3} mieColor The variable the Mie scattering will be written to.\n\
+ * @param {float} opacity The variable the transmittance will be written to.\n\
+ */\n\
+void czm_computeGroundAtmosphereScattering(vec3 positionWC, vec3 lightDirection, out vec3 rayleighColor, out vec3 mieColor, out float opacity) {\n\
+    vec3 cameraToPositionWC = positionWC - czm_viewerPositionWC;\n\
+    vec3 cameraToPositionWCDirection = normalize(cameraToPositionWC);\n\
+    czm_ray primaryRay = czm_ray(czm_viewerPositionWC, cameraToPositionWCDirection);\n\
+\n\
+    float atmosphereInnerRadius = length(positionWC);\n\
+\n\
+    czm_computeScattering(\n\
+        primaryRay,\n\
+        length(cameraToPositionWC),\n\
+        lightDirection,\n\
+        atmosphereInnerRadius,\n\
+        rayleighColor,\n\
+        mieColor,\n\
+        opacity\n\
+    );\n\
+}\n\
+";

package/Source/Shaders/Builtin/Functions/computeScattering.glsl

@@ -0,0 +1,150 @@
+/**
+ * This function computes the colors contributed by Rayliegh and Mie scattering on a given ray, as well as
+ * the transmittance value for the ray. This function uses automatic uniforms
+ * so the atmosphere settings are always synced with the current scene.
+ *
+ * @name czm_computeScattering
+ * @glslfunction
+ *
+ * @param {czm_ray} primaryRay The ray from the camera to the position.
+ * @param {float} primaryRayLength The length of the primary ray.
+ * @param {vec3} lightDirection The direction of the light to calculate the scattering from.
+ * @param {vec3} rayleighColor The variable the Rayleigh scattering will be written to.
+ * @param {vec3} mieColor The variable the Mie scattering will be written to.
+ * @param {float} opacity The variable the transmittance will be written to.
+ */
+void czm_computeScattering(
+    czm_ray primaryRay,
+    float primaryRayLength,
+    vec3 lightDirection,
+    float atmosphereInnerRadius,
+    out vec3 rayleighColor,
+    out vec3 mieColor,
+    out float opacity
+) {
+    const float ATMOSPHERE_THICKNESS = 111e3; // The thickness of the atmosphere in meters.
+    const int PRIMARY_STEPS_MAX = 16; // Maximum number of times the ray from the camera to the world position (primary ray) is sampled.
+    const int LIGHT_STEPS_MAX = 4; // Maximum number of times the light is sampled from the light source's intersection with the atmosphere to a sample position on the primary ray.
+
+    // Initialize the default scattering amounts to 0.
+    rayleighColor = vec3(0.0);
+    mieColor = vec3(0.0);
+    opacity = 0.0;
+
+    float atmosphereOuterRadius = atmosphereInnerRadius + ATMOSPHERE_THICKNESS;
+
+    vec3 origin = vec3(0.0);
+
+    // Calculate intersection from the camera to the outer ring of the atmosphere.
+    czm_raySegment primaryRayAtmosphereIntersect = czm_raySphereIntersectionInterval(primaryRay, origin, atmosphereOuterRadius);
+
+    // Return empty colors if no intersection with the atmosphere geometry.
+    if (primaryRayAtmosphereIntersect == czm_emptyRaySegment) {
+        rayleighColor = vec3(1.0, 0.0, 1.0);
+        return;
+    }
+
+    // To deal with smaller values of PRIMARY_STEPS (e.g. 4)
+    // we implement a split strategy: sky or horizon.
+    // For performance reasons, instead of a if/else branch
+    // a soft choice is implemented through a weight 0.0 <= w_stop_gt_lprl <= 1.0
+    float x = 1e-7 * primaryRayAtmosphereIntersect.stop / length(primaryRayLength);
+    // Value close to 0.0: close to the horizon
+    // Value close to 1.0: above in the sky
+    float w_stop_gt_lprl = 0.5 * (1.0 + czm_approximateTanh(x));
+
+    // The ray should start from the first intersection with the outer atmopshere, or from the camera position, if it is inside the atmosphere.
+    float start_0 = primaryRayAtmosphereIntersect.start;
+    primaryRayAtmosphereIntersect.start = max(primaryRayAtmosphereIntersect.start, 0.0);
+    // The ray should end at the exit from the atmosphere or at the distance to the vertex, whichever is smaller.
+    primaryRayAtmosphereIntersect.stop = min(primaryRayAtmosphereIntersect.stop, length(primaryRayLength));
+
+    // For the number of ray steps, distinguish inside or outside atmosphere (outer space)
+    // (1) from outer space we have to use more ray steps to get a realistic rendering
+    // (2) within atmosphere we need fewer steps for faster rendering
+    float x_o_a = start_0 - ATMOSPHERE_THICKNESS; // ATMOSPHERE_THICKNESS used as an ad-hoc constant, no precise meaning here, only the order of magnitude matters
+    float w_inside_atmosphere = 1.0 - 0.5 * (1.0 + czm_approximateTanh(x_o_a));
+    int PRIMARY_STEPS = PRIMARY_STEPS_MAX - int(w_inside_atmosphere * 12.0); // Number of times the ray from the camera to the world position (primary ray) is sampled.
+    int LIGHT_STEPS = LIGHT_STEPS_MAX - int(w_inside_atmosphere * 2.0); // Number of times the light is sampled from the light source's intersection with the atmosphere to a sample position on the primary ray.
+
+    // Setup for sampling positions along the ray - starting from the intersection with the outer ring of the atmosphere.
+    float rayPositionLength = primaryRayAtmosphereIntersect.start;
+    // (1) Outside the atmosphere: constant rayStepLength
+    // (2) Inside atmosphere: variable rayStepLength to compensate the rough rendering of the smaller number of ray steps
+    float totalRayLength = primaryRayAtmosphereIntersect.stop - rayPositionLength;
+    float rayStepLengthIncrease = w_inside_atmosphere * ((1.0 - w_stop_gt_lprl) * totalRayLength / (float(PRIMARY_STEPS * (PRIMARY_STEPS + 1)) / 2.0));
+    float rayStepLength = max(1.0 - w_inside_atmosphere, w_stop_gt_lprl) * totalRayLength / max(7.0 * w_inside_atmosphere, float(PRIMARY_STEPS));
+
+    vec3 rayleighAccumulation = vec3(0.0);
+    vec3 mieAccumulation = vec3(0.0);
+    vec2 opticalDepth = vec2(0.0);
+    vec2 heightScale = vec2(czm_atmosphereRayleighScaleHeight, czm_atmosphereMieScaleHeight);
+
+    // Sample positions on the primary ray.
+    for (int i = 0; i < PRIMARY_STEPS_MAX; ++i) {
+
+        // The loop should be: for (int i = 0; i < PRIMARY_STEPS; ++i) {...} but WebGL1 cannot
+        // loop with non-constant condition, so it has to break early instead
+        if (i >= PRIMARY_STEPS) {
+            break;
+        }
+
+        // Calculate sample position along viewpoint ray.
+        vec3 samplePosition = primaryRay.origin + primaryRay.direction * (rayPositionLength + rayStepLength);
+
+        // Calculate height of sample position above ellipsoid.
+        float sampleHeight = length(samplePosition) - atmosphereInnerRadius;
+
+        // Calculate and accumulate density of particles at the sample position.
+        vec2 sampleDensity = exp(-sampleHeight / heightScale) * rayStepLength;
+        opticalDepth += sampleDensity;
+
+        // Generate ray from the sample position segment to the light source, up to the outer ring of the atmosphere.
+        czm_ray lightRay = czm_ray(samplePosition, lightDirection);
+        czm_raySegment lightRayAtmosphereIntersect = czm_raySphereIntersectionInterval(lightRay, origin, atmosphereOuterRadius);
+
+        float lightStepLength = lightRayAtmosphereIntersect.stop / float(LIGHT_STEPS);
+        float lightPositionLength = 0.0;
+
+        vec2 lightOpticalDepth = vec2(0.0);
+
+        // Sample positions along the light ray, to accumulate incidence of light on the latest sample segment.
+        for (int j = 0; j < LIGHT_STEPS_MAX; ++j) {
+
+            // The loop should be: for (int j = 0; i < LIGHT_STEPS; ++j) {...} but WebGL1 cannot
+            // loop with non-constant condition, so it has to break early instead
+            if (j >= LIGHT_STEPS) {
+                break;
+            }
+
+            // Calculate sample position along light ray.
+            vec3 lightPosition = samplePosition + lightDirection * (lightPositionLength + lightStepLength * 0.5);
+
+            // Calculate height of the light sample position above ellipsoid.
+            float lightHeight = length(lightPosition) - atmosphereInnerRadius;
+
+            // Calculate density of photons at the light sample position.
+            lightOpticalDepth += exp(-lightHeight / heightScale) * lightStepLength;
+
+            // Increment distance on light ray.
+            lightPositionLength += lightStepLength;
+        }
+
+        // Compute attenuation via the primary ray and the light ray.
+        vec3 attenuation = exp(-((czm_atmosphereMieCoefficient * (opticalDepth.y + lightOpticalDepth.y)) + (czm_atmosphereRayleighCoefficient * (opticalDepth.x + lightOpticalDepth.x))));
+
+        // Accumulate the scattering.
+        rayleighAccumulation += sampleDensity.x * attenuation;
+        mieAccumulation += sampleDensity.y * attenuation;
+
+        // Increment distance on primary ray.
+        rayPositionLength += (rayStepLength += rayStepLengthIncrease);
+    }
+
+    // Compute the scattering amount.
+    rayleighColor = czm_atmosphereRayleighCoefficient * rayleighAccumulation;
+    mieColor = czm_atmosphereMieCoefficient * mieAccumulation;
+
+    // Compute the transmittance i.e. how much light is passing through the atmosphere.
+    opacity = length(exp(-((czm_atmosphereMieCoefficient * opticalDepth.y) + (czm_atmosphereRayleighCoefficient * opticalDepth.x))));
+}

package/Source/Shaders/Builtin/Functions/computeScattering.js

@@ -0,0 +1,152 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "/**\n\
+ * This function computes the colors contributed by Rayliegh and Mie scattering on a given ray, as well as\n\
+ * the transmittance value for the ray. This function uses automatic uniforms\n\
+ * so the atmosphere settings are always synced with the current scene.\n\
+ *\n\
+ * @name czm_computeScattering\n\
+ * @glslfunction\n\
+ *\n\
+ * @param {czm_ray} primaryRay The ray from the camera to the position.\n\
+ * @param {float} primaryRayLength The length of the primary ray.\n\
+ * @param {vec3} lightDirection The direction of the light to calculate the scattering from.\n\
+ * @param {vec3} rayleighColor The variable the Rayleigh scattering will be written to.\n\
+ * @param {vec3} mieColor The variable the Mie scattering will be written to.\n\
+ * @param {float} opacity The variable the transmittance will be written to.\n\
+ */\n\
+void czm_computeScattering(\n\
+    czm_ray primaryRay,\n\
+    float primaryRayLength,\n\
+    vec3 lightDirection,\n\
+    float atmosphereInnerRadius,\n\
+    out vec3 rayleighColor,\n\
+    out vec3 mieColor,\n\
+    out float opacity\n\
+) {\n\
+    const float ATMOSPHERE_THICKNESS = 111e3; // The thickness of the atmosphere in meters.\n\
+    const int PRIMARY_STEPS_MAX = 16; // Maximum number of times the ray from the camera to the world position (primary ray) is sampled.\n\
+    const int LIGHT_STEPS_MAX = 4; // Maximum number of times the light is sampled from the light source's intersection with the atmosphere to a sample position on the primary ray.\n\
+\n\
+    // Initialize the default scattering amounts to 0.\n\
+    rayleighColor = vec3(0.0);\n\
+    mieColor = vec3(0.0);\n\
+    opacity = 0.0;\n\
+\n\
+    float atmosphereOuterRadius = atmosphereInnerRadius + ATMOSPHERE_THICKNESS;\n\
+\n\
+    vec3 origin = vec3(0.0);\n\
+\n\
+    // Calculate intersection from the camera to the outer ring of the atmosphere.\n\
+    czm_raySegment primaryRayAtmosphereIntersect = czm_raySphereIntersectionInterval(primaryRay, origin, atmosphereOuterRadius);\n\
+\n\
+    // Return empty colors if no intersection with the atmosphere geometry.\n\
+    if (primaryRayAtmosphereIntersect == czm_emptyRaySegment) {\n\
+        rayleighColor = vec3(1.0, 0.0, 1.0);\n\
+        return;\n\
+    }\n\
+\n\
+    // To deal with smaller values of PRIMARY_STEPS (e.g. 4)\n\
+    // we implement a split strategy: sky or horizon.\n\
+    // For performance reasons, instead of a if/else branch\n\
+    // a soft choice is implemented through a weight 0.0 <= w_stop_gt_lprl <= 1.0\n\
+    float x = 1e-7 * primaryRayAtmosphereIntersect.stop / length(primaryRayLength);\n\
+    // Value close to 0.0: close to the horizon\n\
+    // Value close to 1.0: above in the sky\n\
+    float w_stop_gt_lprl = 0.5 * (1.0 + czm_approximateTanh(x));\n\
+\n\
+    // The ray should start from the first intersection with the outer atmopshere, or from the camera position, if it is inside the atmosphere.\n\
+    float start_0 = primaryRayAtmosphereIntersect.start;\n\
+    primaryRayAtmosphereIntersect.start = max(primaryRayAtmosphereIntersect.start, 0.0);\n\
+    // The ray should end at the exit from the atmosphere or at the distance to the vertex, whichever is smaller.\n\
+    primaryRayAtmosphereIntersect.stop = min(primaryRayAtmosphereIntersect.stop, length(primaryRayLength));\n\
+\n\
+    // For the number of ray steps, distinguish inside or outside atmosphere (outer space)\n\
+    // (1) from outer space we have to use more ray steps to get a realistic rendering\n\
+    // (2) within atmosphere we need fewer steps for faster rendering\n\
+    float x_o_a = start_0 - ATMOSPHERE_THICKNESS; // ATMOSPHERE_THICKNESS used as an ad-hoc constant, no precise meaning here, only the order of magnitude matters\n\
+    float w_inside_atmosphere = 1.0 - 0.5 * (1.0 + czm_approximateTanh(x_o_a));\n\
+    int PRIMARY_STEPS = PRIMARY_STEPS_MAX - int(w_inside_atmosphere * 12.0); // Number of times the ray from the camera to the world position (primary ray) is sampled.\n\
+    int LIGHT_STEPS = LIGHT_STEPS_MAX - int(w_inside_atmosphere * 2.0); // Number of times the light is sampled from the light source's intersection with the atmosphere to a sample position on the primary ray.\n\
+\n\
+    // Setup for sampling positions along the ray - starting from the intersection with the outer ring of the atmosphere.\n\
+    float rayPositionLength = primaryRayAtmosphereIntersect.start;\n\
+    // (1) Outside the atmosphere: constant rayStepLength\n\
+    // (2) Inside atmosphere: variable rayStepLength to compensate the rough rendering of the smaller number of ray steps\n\
+    float totalRayLength = primaryRayAtmosphereIntersect.stop - rayPositionLength;\n\
+    float rayStepLengthIncrease = w_inside_atmosphere * ((1.0 - w_stop_gt_lprl) * totalRayLength / (float(PRIMARY_STEPS * (PRIMARY_STEPS + 1)) / 2.0));\n\
+    float rayStepLength = max(1.0 - w_inside_atmosphere, w_stop_gt_lprl) * totalRayLength / max(7.0 * w_inside_atmosphere, float(PRIMARY_STEPS));\n\
+\n\
+    vec3 rayleighAccumulation = vec3(0.0);\n\
+    vec3 mieAccumulation = vec3(0.0);\n\
+    vec2 opticalDepth = vec2(0.0);\n\
+    vec2 heightScale = vec2(czm_atmosphereRayleighScaleHeight, czm_atmosphereMieScaleHeight);\n\
+\n\
+    // Sample positions on the primary ray.\n\
+    for (int i = 0; i < PRIMARY_STEPS_MAX; ++i) {\n\
+\n\
+        // The loop should be: for (int i = 0; i < PRIMARY_STEPS; ++i) {...} but WebGL1 cannot\n\
+        // loop with non-constant condition, so it has to break early instead\n\
+        if (i >= PRIMARY_STEPS) {\n\
+            break;\n\
+        }\n\
+\n\
+        // Calculate sample position along viewpoint ray.\n\
+        vec3 samplePosition = primaryRay.origin + primaryRay.direction * (rayPositionLength + rayStepLength);\n\
+\n\
+        // Calculate height of sample position above ellipsoid.\n\
+        float sampleHeight = length(samplePosition) - atmosphereInnerRadius;\n\
+\n\
+        // Calculate and accumulate density of particles at the sample position.\n\
+        vec2 sampleDensity = exp(-sampleHeight / heightScale) * rayStepLength;\n\
+        opticalDepth += sampleDensity;\n\
+\n\
+        // Generate ray from the sample position segment to the light source, up to the outer ring of the atmosphere.\n\
+        czm_ray lightRay = czm_ray(samplePosition, lightDirection);\n\
+        czm_raySegment lightRayAtmosphereIntersect = czm_raySphereIntersectionInterval(lightRay, origin, atmosphereOuterRadius);\n\
+\n\
+        float lightStepLength = lightRayAtmosphereIntersect.stop / float(LIGHT_STEPS);\n\
+        float lightPositionLength = 0.0;\n\
+\n\
+        vec2 lightOpticalDepth = vec2(0.0);\n\
+\n\
+        // Sample positions along the light ray, to accumulate incidence of light on the latest sample segment.\n\
+        for (int j = 0; j < LIGHT_STEPS_MAX; ++j) {\n\
+\n\
+            // The loop should be: for (int j = 0; i < LIGHT_STEPS; ++j) {...} but WebGL1 cannot\n\
+            // loop with non-constant condition, so it has to break early instead\n\
+            if (j >= LIGHT_STEPS) {\n\
+                break;\n\
+            }\n\
+\n\
+            // Calculate sample position along light ray.\n\
+            vec3 lightPosition = samplePosition + lightDirection * (lightPositionLength + lightStepLength * 0.5);\n\
+\n\
+            // Calculate height of the light sample position above ellipsoid.\n\
+            float lightHeight = length(lightPosition) - atmosphereInnerRadius;\n\
+\n\
+            // Calculate density of photons at the light sample position.\n\
+            lightOpticalDepth += exp(-lightHeight / heightScale) * lightStepLength;\n\
+\n\
+            // Increment distance on light ray.\n\
+            lightPositionLength += lightStepLength;\n\
+        }\n\
+\n\
+        // Compute attenuation via the primary ray and the light ray.\n\
+        vec3 attenuation = exp(-((czm_atmosphereMieCoefficient * (opticalDepth.y + lightOpticalDepth.y)) + (czm_atmosphereRayleighCoefficient * (opticalDepth.x + lightOpticalDepth.x))));\n\
+\n\
+        // Accumulate the scattering.\n\
+        rayleighAccumulation += sampleDensity.x * attenuation;\n\
+        mieAccumulation += sampleDensity.y * attenuation;\n\
+\n\
+        // Increment distance on primary ray.\n\
+        rayPositionLength += (rayStepLength += rayStepLengthIncrease);\n\
+    }\n\
+\n\
+    // Compute the scattering amount.\n\
+    rayleighColor = czm_atmosphereRayleighCoefficient * rayleighAccumulation;\n\
+    mieColor = czm_atmosphereMieCoefficient * mieAccumulation;\n\
+\n\
+    // Compute the transmittance i.e. how much light is passing through the atmosphere.\n\
+    opacity = length(exp(-((czm_atmosphereMieCoefficient * opticalDepth.y) + (czm_atmosphereRayleighCoefficient * opticalDepth.x))));\n\
+}\n\
+";

package/Source/Shaders/Builtin/Functions/getDynamicAtmosphereLightDirection.glsl

@@ -0,0 +1,22 @@
+/**
+ * Select which direction vector to use for dynamic atmosphere lighting based on an enum value
+ *
+ * @name czm_getDynamicAtmosphereLightDirection
+ * @glslfunction
+ * @see DynamicAtmosphereLightingType.js
+ *
+ * @param {vec3} positionWC the position of the vertex/fragment in world coordinates. This is normalized and returned when dynamic lighting is turned off.
+ * @param {float} lightEnum The enum value for selecting between light sources.
+ * @return {vec3} The normalized light direction vector. Depending on the enum value, it is either positionWC, czm_lightDirectionWC or czm_sunDirectionWC
+ */
+vec3 czm_getDynamicAtmosphereLightDirection(vec3 positionWC, float lightEnum) {
+    const float NONE = 0.0;
+    const float SCENE_LIGHT = 1.0;
+    const float SUNLIGHT = 2.0;
+
+    vec3 lightDirection =
+        positionWC * float(lightEnum == NONE) +
+        czm_lightDirectionWC * float(lightEnum == SCENE_LIGHT) +
+        czm_sunDirectionWC * float(lightEnum == SUNLIGHT);
+    return normalize(lightDirection);
+}

package/Source/Shaders/Builtin/Functions/getDynamicAtmosphereLightDirection.js

@@ -0,0 +1,24 @@
+//This file is automatically rebuilt by the Cesium build process.
+export default "/**\n\
+ * Select which direction vector to use for dynamic atmosphere lighting based on an enum value\n\
+ *\n\
+ * @name czm_getDynamicAtmosphereLightDirection\n\
+ * @glslfunction\n\
+ * @see DynamicAtmosphereLightingType.js\n\
+ *\n\
+ * @param {vec3} positionWC the position of the vertex/fragment in world coordinates. This is normalized and returned when dynamic lighting is turned off.\n\
+ * @param {float} lightEnum The enum value for selecting between light sources.\n\
+ * @return {vec3} The normalized light direction vector. Depending on the enum value, it is either positionWC, czm_lightDirectionWC or czm_sunDirectionWC\n\
+ */\n\
+vec3 czm_getDynamicAtmosphereLightDirection(vec3 positionWC, float lightEnum) {\n\
+    const float NONE = 0.0;\n\
+    const float SCENE_LIGHT = 1.0;\n\
+    const float SUNLIGHT = 2.0;\n\
+\n\
+    vec3 lightDirection =\n\
+        positionWC * float(lightEnum == NONE) +\n\
+        czm_lightDirectionWC * float(lightEnum == SCENE_LIGHT) +\n\
+        czm_sunDirectionWC * float(lightEnum == SUNLIGHT);\n\
+    return normalize(lightDirection);\n\
+}\n\
+";

package/Source/Shaders/Builtin/Functions/translateRelativeToEye.glsl

@@ -34,6 +34,11 @@
 vec4 czm_translateRelativeToEye(vec3 high, vec3 low)
 {
     vec3 highDifference = high - czm_encodedCameraPositionMCHigh;
+    // This check handles the case when NaN values have gotten into `highDifference`.
+    // Such a thing could happen on devices running iOS.
+    if (length(highDifference) == 0.0) {  
+        highDifference = vec3(0);  
+    }
     vec3 lowDifference = low - czm_encodedCameraPositionMCLow;
 
     return vec4(highDifference + lowDifference, 1.0);

package/Source/Shaders/Builtin/Functions/translateRelativeToEye.js

@@ -35,6 +35,11 @@ export default "/**\n\
 vec4 czm_translateRelativeToEye(vec3 high, vec3 low)\n\
 {\n\
     vec3 highDifference = high - czm_encodedCameraPositionMCHigh;\n\
+    // This check handles the case when NaN values have gotten into `highDifference`.\n\
+    // Such a thing could happen on devices running iOS.\n\
+    if (length(highDifference) == 0.0) {  \n\
+        highDifference = vec3(0);  \n\
+    }\n\
     vec3 lowDifference = low - czm_encodedCameraPositionMCLow;\n\
 \n\
     return vec4(highDifference + lowDifference, 1.0);\n\

package/Source/Shaders/GlobeFS.glsl

@@ -268,20 +268,6 @@ vec4 sampleAndBlend(
     return vec4(outColor, max(outAlpha, 0.0));
 }
 
-vec3 colorCorrect(vec3 rgb) {
-#ifdef COLOR_CORRECT
-    // Convert rgb color to hsb
-    vec3 hsb = czm_RGBToHSB(rgb);
-    // Perform hsb shift
-    hsb.x += u_hsbShift.x; // hue
-    hsb.y = clamp(hsb.y + u_hsbShift.y, 0.0, 1.0); // saturation
-    hsb.z = hsb.z > czm_epsilon7 ? hsb.z + u_hsbShift.z : 0.0; // brightness
-    // Convert shifted hsb back to rgb
-    rgb = czm_HSBToRGB(hsb);
-#endif
-    return rgb;
-}
-
 vec4 computeDayColor(vec4 initialColor, vec3 textureCoordinates, float nightBlend);
 vec4 computeWaterColor(vec3 positionEyeCoordinates, vec2 textureCoordinates, mat3 enuToEye, vec4 imageryColor, float specularMapValue, float fade);
 
@@ -396,7 +382,7 @@ void main()
     materialInput.st = v_textureCoordinates.st;
     materialInput.normalEC = normalize(v_normalEC);
     materialInput.positionToEyeEC = -v_positionEC;
-    materialInput.tangentToEyeMatrix = czm_eastNorthUpToEyeCoordinates(v_positionMC, normalize(v_normalEC));     
+    materialInput.tangentToEyeMatrix = czm_eastNorthUpToEyeCoordinates(v_positionMC, normalize(v_normalEC));
     materialInput.slope = v_slope;
     materialInput.height = v_height;
     materialInput.aspect = v_aspect;
@@ -442,7 +428,7 @@ void main()
     {
         bool dynamicLighting = false;
         #if defined(DYNAMIC_ATMOSPHERE_LIGHTING) && (defined(ENABLE_DAYNIGHT_SHADING) || defined(ENABLE_VERTEX_LIGHTING))
-            dynamicLighting = true;     
+            dynamicLighting = true;
         #endif
 
         vec3 rayleighColor;
@@ -472,30 +458,35 @@ void main()
             opacity = v_atmosphereOpacity;
         #endif
 
-        rayleighColor = colorCorrect(rayleighColor);
-        mieColor = colorCorrect(mieColor);
+        #ifdef COLOR_CORRECT
+            const bool ignoreBlackPixels = true;
+            rayleighColor = czm_applyHSBShift(rayleighColor, u_hsbShift, ignoreBlackPixels);
+            mieColor = czm_applyHSBShift(mieColor, u_hsbShift, ignoreBlackPixels);
+        #endif
 
         vec4 groundAtmosphereColor = computeAtmosphereColor(positionWC, lightDirection, rayleighColor, mieColor, opacity);
 
         // Fog is applied to tiles selected for fog, close to the Earth.
         #ifdef FOG
             vec3 fogColor = groundAtmosphereColor.rgb;
-            
+
             // If there is lighting, apply that to the fog.
             #if defined(DYNAMIC_ATMOSPHERE_LIGHTING) && (defined(ENABLE_VERTEX_LIGHTING) || defined(ENABLE_DAYNIGHT_SHADING))
                 float darken = clamp(dot(normalize(czm_viewerPositionWC), atmosphereLightDirection), u_minimumBrightness, 1.0);
-                fogColor *= darken;                
+                fogColor *= darken;
             #endif
 
             #ifndef HDR
                 fogColor.rgb = czm_acesTonemapping(fogColor.rgb);
                 fogColor.rgb = czm_inverseGamma(fogColor.rgb);
             #endif
-            
+
             const float modifier = 0.15;
             finalColor = vec4(czm_fog(v_distance, finalColor.rgb, fogColor.rgb, modifier), finalColor.a);
 
         #else
+            // Apply ground atmosphere. This happens when the camera is far away from the earth.
+
             // The transmittance is based on optical depth i.e. the length of segment of the ray inside the atmosphere.
             // This value is larger near the "circumference", as it is further away from the camera. We use it to
             // brighten up that area of the ground atmosphere.
@@ -507,20 +498,20 @@ void main()
             #if defined(DYNAMIC_ATMOSPHERE_LIGHTING) && (defined(ENABLE_VERTEX_LIGHTING) || defined(ENABLE_DAYNIGHT_SHADING))
                 float fadeInDist = u_nightFadeDistance.x;
                 float fadeOutDist = u_nightFadeDistance.y;
-            
+
                 float sunlitAtmosphereIntensity = clamp((cameraDist - fadeOutDist) / (fadeInDist - fadeOutDist), 0.05, 1.0);
                 float darken = clamp(dot(normalize(positionWC), atmosphereLightDirection), 0.0, 1.0);
                 vec3 darkenendGroundAtmosphereColor = mix(groundAtmosphereColor.rgb, finalAtmosphereColor.rgb, darken);
 
                 finalAtmosphereColor = mix(darkenendGroundAtmosphereColor, finalAtmosphereColor, sunlitAtmosphereIntensity);
             #endif
-            
+
             #ifndef HDR
                 finalAtmosphereColor.rgb = vec3(1.0) - exp(-fExposure * finalAtmosphereColor.rgb);
             #else
                 finalAtmosphereColor.rgb = czm_saturation(finalAtmosphereColor.rgb, 1.6);
             #endif
-            
+
             finalColor.rgb = mix(finalColor.rgb, finalAtmosphereColor.rgb, fade);
         #endif
     }
@@ -544,7 +535,7 @@ void main()
       finalColor.a *= interpolateByDistance(alphaByDistance, v_distance);
     }
 #endif
-    
+
     out_FragColor =  finalColor;
 }