Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...
    • The zarr spelling of an environment config, for the Ctrl+Shift+S export.

      Parameters

      Returns {
          source?: string;
          probe?: string | [number, number, number];
          resolution?: number;
          intensity?: number;
          url?: string;
      }

      • Optionalsource?: string

        room (default), scene (exact cube capture from probe), hdri (url).

      • Optionalprobe?: string | [number, number, number]

        'auto', 'node:<path>', or an [x, y, z] world position.

      • Optionalresolution?: number

        Cube face size in pixels for a scene capture, 16–1024.

      • Optionalintensity?: number

        scene.environmentIntensity, >= 0.

      • Optionalurl?: string

        Equirectangular image for hdri, relative to the store or absolute.