Strata - v1.4.10
    Preparing search index...

    Interface GodRaysProps

    Props for the GodRays component.

    interface GodRaysProps {
        atmosphereColor?: ColorRepresentation;
        color?: ColorRepresentation;
        decay?: number;
        density?: number;
        enabled?: boolean;
        exposure?: number;
        intensity?: number;
        lightPosition?: [number, number, number] | Vector3;
        noiseFactor?: number;
        samples?: number;
        scattering?: number;
        sunAltitude?: number;
    }
    Index

    Properties

    atmosphereColor?: ColorRepresentation

    Color used for sunset/sunrise atmosphere blending. Default: 0xff9944.

    color?: ColorRepresentation

    Base color of the light rays. Default: 0xffffee.

    decay?: number

    How quickly rays fade with screen distance from the source. Default: 0.95.

    density?: number

    Density/thickness of the light shafts. Default: 1.0.

    enabled?: boolean

    Whether the effect is currently enabled. Default: true.

    exposure?: number

    Final exposure adjustment. Default: 1.0.

    intensity?: number

    Overall intensity multiplier. Default: 1.0.

    lightPosition?: [number, number, number] | Vector3

    World position of the light source (sun/moon). Default: [100, 50, 0].

    noiseFactor?: number

    Amount of noise variation in the shafts. Default: 0.3.

    samples?: number

    Number of raymarching samples. Higher = better quality. Default: 50.

    scattering?: number

    Atmospheric scattering coefficient. Default: 2.0.

    sunAltitude?: number

    Sun altitude in degrees for automatic color/intensity shifting.