Function sunDirection

  • sunDirection(
        position: SunPosition,
        northAngleRadians?: number,
        out?: number[] | Float32Array<ArrayBufferLike>,
    ): number[] | Float32Array<ArrayBufferLike>

    Convert a SunPosition to a Cartesian direction-of-light vector suitable for view.lights.* DirLight.dir. Output is a unit vector in Z-up, X=east, Y=north world frame.

    The vector points FROM the sun INTO the scene — i.e. it's the direction sunlight travels, not the direction back to the sun. That matches how every renderer in this SDK interprets a directional light's dir.

    Parameters

    • position: SunPosition

      Sun position from computeSunPosition.

    • northAngleRadians: number = 0

      Optional clockwise rotation of the scene's Y-axis away from true north. 0 (default) means the scene's +Y IS true north.

    • Optionalout: number[] | Float32Array<ArrayBufferLike>

      Pre-allocated output (Float32Array | number[]). Allocated fresh if omitted.

    Returns number[] | Float32Array<ArrayBufferLike>

Settings

Member Visibility