AutoMovie API
    Preparing search index...

    Interface IAutoMovieSceneEnvironment

    Image-based lighting, background, exposure, tone mapping, and shadows.

    interface IAutoMovieSceneEnvironment {
        background: IAutoMovieColor | null;
        exposure: number;
        image: string | null;
        intensity: number;
        rotationDeg: number;
        shadows: { enabled: boolean; type: "pcf" | "pcfSoft" | "vsm" };
        toneMapping: "none" | "acesFilmic";
    }
    Index
    background: IAutoMovieColor | null

    Solid background when image is null, or null for transparent black.

    exposure: number

    Positive renderer exposure multiplier.

    image: string | null

    Equirectangular HDR/LDR asset id, or null for no image-based lighting.

    This carries no authored colour-space field. Production asset closure interprets supported Radiance header facts as linear and PNG/JPEG/WebP facts as sRGB, checking other uses for contradictory intent. The viewer instead treats unsigned-byte decoded storage as sRGB and other storage as linear; the host decoder must agree with that convention. Neither header media nor storage type certifies a source colour profile or physical radiance, and an unresolved image supplies no image lighting.

    intensity: number

    Non-negative image-based-light intensity.

    rotationDeg: number

    Finite world-Y rotation of the environment in degrees.

    shadows: { enabled: boolean; type: "pcf" | "pcfSoft" | "vsm" }

    Renderer shadow-map policy for physical scene lights.

    The master switch, and it outranks the lights: enabled: false renders no shadow map for this scene's beauty pass however many of its lights declare castShadow, and the render budget prices them the same way. A light's castShadow and shadow settings therefore state what that light would cast; this states whether the scene pays for any of it, which is what lets a draft drop the whole cost without editing every light in the set.

    Type Declaration

    • enabled: boolean

      Whether shadow maps are rendered in beauty passes.

    • type: "pcf" | "pcfSoft" | "vsm"

      Effective filters are PCF and VSM. The legacy pcfSoft spelling is a PCF alias. VSM is supported for directional and spot shadows; enabled shadow-casting point lights with VSM are refused before rendering.

    toneMapping: "none" | "acesFilmic"

    Beauty-pass tone mapping; structural passes always bypass it.

    Authoritative over IAutoMovieRenderSpec.toneMapping for every scene that declares an environment: the curve belongs with the exposure and image lighting it is chosen against, and one render spec spans many scenes.