Class Clouds

constructor

• new Clouds(input?: CloudInput): Clouds

  Creates both layers; anything not given uses DEFAULT_CLOUDS.

  Parameters

  • input: CloudInput = {}

  Returns Clouds

Readonlyobject

settings

Readonlyuniforms

coverAt

• coverAt(x: number, y: number, z: number): number

  Cloud cover 0..1 at a render-space position right now (low clouds; the same field the splats are placed from, drifting with the wind). Use it to align rain, shadows or gameplay with the clouds.

  Parameters

  • x: number
  • y: number
  • z: number

  Returns number

dispose

• dispose(): void

  Frees GPU resources.

  Returns void

reset

• reset(input?: CloudInput): this

  Replaces all settings; anything not given goes back to DEFAULT_CLOUDS.

  Parameters

  • input: CloudInput = {}

  Returns this

set

• set(input: CloudInput): this

  Merges settings.

  Parameters

  • input: CloudInput

  Returns this

update

• update(
      state: SkyState,
      camera: Vec3,
      light: {
          ambient: Vec3;
          haze: Vec3;
          hazeFade: number;
          moon: Vec3;
          sun: Vec3;
      },
      altitudeScale: number,
      troposphere: number,
      anchor: [number, number],
  ): void

  Places and lights the clouds for this frame. Called by Sky.

  Parameters

  • state: SkyState

    Sky state (frame, camera position relative to the planet, sun and moon).

  • camera: Vec3

    Camera position, render space.

  • light: { ambient: Vec3; haze: Vec3; hazeFade: number; moon: Vec3; sun: Vec3 }

    Radiances (direct sun, moon, sky ambient, haze colour; linear RGB) and hazeFade 0..1 (0 above the Kármán line).

  • altitudeScale: number

    Atmosphere altitude scale (planet radius / Earth radius, or 1).

  • troposphere: number

    Tropopause altitude (for the orbital cross-fade), metres.

  • anchor: [number, number]

    Latitude/longitude the detailed layer's tangent plane is anchored at (planet frame).

  Returns void