Taos API Reference
    Preparing search index...

    Interface HQCloudSettings

    interface HQCloudSettings {
        preset: number;
        earthRadius: number;
        earthCurvature: number;
        planetCenter?: [number, number, number];
        bottomAltitude: number;
        altitudeRange: number;
        localClouds: boolean;
        coverage: number;
        density: number;
        shapeFactor: number;
        shapeScale: number;
        erosionFactor: number;
        erosionScale: number;
        microErosion: boolean;
        microErosionScale: number;
        altitudeDistortion: number;
        windOffset: [number, number];
        windDir: [number, number];
        anisotropy: number;
        extinction: number;
        ambientColor: [number, number, number];
        scatteringTint: [number, number, number];
        ambientDimmer: number;
        shapeOffset: [number, number, number];
        verticalShapeOffset: number;
        exposure: number;
        multiScatter: number;
        weatherScale: number;
        coverageVariation: number;
        densityVariation: number;
        godrayStrength: number;
        cirrus: boolean;
        cirrusBase: number;
        cirrusRange: number;
        cirrusCoverage: number;
        cirrusDensity: number;
        cirrusScale: number;
        beerShadow: boolean;
        beerShadowStrength: number;
        primarySteps: number;
        reprojectBlend: number;
        atmosphereRE: number;
        atmosphereHeight: number;
    }
    Index

    Properties

    preset: number

    Active cloud preset (0 Sparse, 1 Cloudy, 2 Overcast, 3 Stormy). Selects the vertical density/erosion/AO height curves in-shader. The scalar params (density, shapeFactor, erosion*, altitudes) are set by the host alongside this — see DEFAULT_HQ_CLOUD_SETTINGS / the sample.

    earthRadius: number

    Planet surface radius in meters BEFORE the Earth-curvature scale. The shell is a sphere centered at planetCenter; near the camera a large radius reads as a flat slab, so this single model serves both stylised (small R) and planetary (Earth R) scales.

    earthCurvature: number

    0..1 "Earth Curvature" (report §3.1). 0 = full earthRadius (deck stays near-flat to a distant horizon); 1 = radius shrunk to 2.5 % so the deck visibly bends below the horizon close to the camera.

    planetCenter?: [number, number, number]

    Optional explicit planet center (world space). When omitted the pass uses (0, -R, 0) with R the curvature-scaled radius, so world Y reads as altitude in meters (a camera at y=1.7 stands 1.7 m above sea level).

    bottomAltitude: number

    Cloud-deck bottom altitude above the surface, meters (report "Cloudy" ≈1200).

    altitudeRange: number

    Cloud-deck thickness, meters (report "Cloudy" ≈2000). Drives all scale-relative distance controls (step size, fades, mip ramps).

    localClouds: boolean

    false = global/skybox clouds (sky pixels only, below-horizon cull, follows camera); true = local/scene clouds (depth-clamped, fly-through).

    coverage: number

    0..1 sky cover ratio.

    density: number

    Multiplier on the sampled density field.

    shapeFactor: number

    How hard the low-frequency noise carves coverage (report §4.7).

    shapeScale: number

    Low-frequency wavelength multiplier (bigger = smaller clouds).

    erosionFactor: number

    Edge-erosion strength (report §6).

    erosionScale: number

    Erosion wavelength multiplier.

    microErosion: boolean

    Enables the second, finer micro-erosion fetch (report §6, costly).

    microErosionScale: number

    Micro-erosion wavelength multiplier.

    altitudeDistortion: number

    Downwind lean per unit height (report §8.5) — decorrelates the vertical profile to further break repetition.

    windOffset: [number, number]

    Pre-rotated wind offset added to noise sample positions; host accumulates.

    windDir: [number, number]

    Wind heading unit vector for the altitude-distortion lean.

    anisotropy: number

    Henyey-Greenstein asymmetry (~0.85 = strong forward).

    extinction: number

    Extinction coefficient. Beer's-law transmittance per unit optical depth.

    ambientColor: [number, number, number]

    Linear-RGB ambient/sky tint added to cloud lighting (height-weighted).

    scatteringTint: [number, number, number]

    Scattering tint — multiplies the sun in-scatter. White = no tint.

    ambientDimmer: number

    Ambient probe dimmer — scales the ambient term.

    shapeOffset: [number, number, number]

    Noise sample offset (x,z horizontal) in noise-space units.

    verticalShapeOffset: number

    Vertical noise sample offset.

    exposure: number

    Exposure of the cloud-only luminance, applied as exp2(exposure).

    multiScatter: number

    Multi-scattering octave strength, 0 = single scatter, 1 = full Wrenninge.

    weatherScale: number

    Weather-noise feature scale (bigger = smaller patches).

    coverageVariation: number

    ± fraction the weather noise applies to coverage across the sky (0 = uniform).

    densityVariation: number

    ± fraction the weather noise applies to density across the sky (0 = uniform).

    godrayStrength: number

    God-ray (crepuscular shaft) intensity, 0 = off. Marches the view ray sampling the Beer Shadow Map, so shafts of in-scattered sunlight match the actual cloud occlusion. Requires the pass created with beerShadowMap: true.

    cirrus: boolean

    Enable a thin high cirrus sheet above the main deck.

    cirrusBase: number

    Cirrus base altitude (m above surface) and band thickness (m).

    cirrusRange: number
    cirrusCoverage: number

    Cirrus cover ratio (sharpens its silhouette) and density multiplier.

    cirrusDensity: number
    cirrusScale: number

    Cirrus noise feature scale (bigger = finer wisps).

    beerShadow: boolean

    Beer Shadow Map self-shadowing — runtime toggle (the pass must be created with beerShadowMap: true for the path to be compiled in; this just turns it on/off live). When off, the per-sample 5-step light march is used.

    beerShadowStrength: number

    Beer Shadow Map optical-depth multiplier (artist dial; 1 = physical).

    primarySteps: number

    Primary-march step count target (clamped 24..160 in-shader).

    reprojectBlend: number

    Temporal blend weight toward the current frame in the reproject pass. Smaller = stronger history bias (smooth but laggy); larger = more responsive (noisier). 0.08 is a reasonable default.

    atmosphereRE: number

    Atmosphere planet surface radius and atmosphere thickness — only used when the pass is wired with a transmittance LUT. Match the values the host passes to AtmosphereLutsFeature. Ignored when useTransmittanceLut is off.

    atmosphereHeight: number