Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...
    interface RenderingSettings {
        fov: number;
        fovPreset:
            | "28mm Wide"
            | "35mm"
            | "50mm Normal"
            | "85mm Portrait"
            | "135mm Tele"
            | "Custom";
        near: number;
        far: number;
        dynamicClippingEnabled: boolean;
        bloomEnabled: boolean;
        bloomThreshold: number;
        bloomStrength: number;
        bloomRadius: number;
        bloomLevels: number;
        exposure: number;
        globalOffset: number;
        globalGamma: number;
        fxaaEnabled: boolean;
        msaaEnabled: boolean;
        msaaSamples: number;
        ssaaEnabled: boolean;
        ssaaMultiplier: number;
        toneMapping: ToneMappingName;
        vignetteEnabled: boolean;
        vignetteDarkness: number;
        vignetteOffset: number;
        detectorNoiseEnabled: boolean;
        detectorNoiseReadoutSigma: number;
        detectorNoisePhotonGain: number;
        detectorNoiseFpnSigma: number;
        chromaticLensDistortionEnabled: boolean;
        chromaticLensDistortionX: number;
        chromaticLensDistortionY: number;
        chromaticLensDispersion: number;
        chromaticLensPrincipalPointX: number;
        chromaticLensPrincipalPointY: number;
        chromaticLensFocalLengthX: number;
        chromaticLensFocalLengthY: number;
        chromaticLensSkew: number;
        controlType: "orbit"
        | "fly"
        | "ortho";
        autoRotate: boolean;
        autoRotateSpeed: number;
        autoRotateAxis: AutoRotateAxis;
        autoDolly: boolean;
        autoDollyAmplitudePercent: number;
        autoDollyPeriod: number;
        naturalDrag: boolean;
        orbitZoomSpeed?: number;
        orbitDampingFactor?: number;
        flyMovementSpeed?: number;
        flyRotationSpeed?: number;
        flyLookSpeed?: number;
        flyInertialMode?: boolean;
        flyDamping?: number;
        flyRotationDamping?: number;
        adaptiveDPREnabled: boolean;
        allowHighDPR: boolean;
        densityGuardEnabled: boolean;
        cinematicMode: boolean;
    }
    Index
    fov: number
    fovPreset:
        | "28mm Wide"
        | "35mm"
        | "50mm Normal"
        | "85mm Portrait"
        | "135mm Tele"
        | "Custom"
    near: number
    far: number
    dynamicClippingEnabled: boolean
    bloomEnabled: boolean
    bloomThreshold: number
    bloomStrength: number
    bloomRadius: number
    bloomLevels: number
    exposure: number
    globalOffset: number
    globalGamma: number
    fxaaEnabled: boolean
    msaaEnabled: boolean
    msaaSamples: number
    ssaaEnabled: boolean
    ssaaMultiplier: number
    toneMapping: ToneMappingName

    Tone-mapping operator by name; single-sourced from format-contract/contract.yaml::tone_mappings.

    vignetteEnabled: boolean
    vignetteDarkness: number
    vignetteOffset: number
    detectorNoiseEnabled: boolean
    detectorNoiseReadoutSigma: number
    detectorNoisePhotonGain: number
    detectorNoiseFpnSigma: number
    chromaticLensDistortionEnabled: boolean
    chromaticLensDistortionX: number
    chromaticLensDistortionY: number
    chromaticLensDispersion: number
    chromaticLensPrincipalPointX: number
    chromaticLensPrincipalPointY: number
    chromaticLensFocalLengthX: number
    chromaticLensFocalLengthY: number
    chromaticLensSkew: number
    controlType: "orbit" | "fly" | "ortho"
    autoRotate: boolean
    autoRotateSpeed: number
    autoRotateAxis: AutoRotateAxis

    Camera-frame or fixed scene axis the orbit turntable revolves around; see AutoRotateAxis. Orbit only; ortho disables rotation and fly has no turntable.

    autoDolly: boolean

    Auto-dolly: oscillate the viewing distance on a sine — the turntable's radial sibling. Unlike the turntable it is alive in ortho too, where it breathes camera.zoom.

    autoDollyAmplitudePercent: number

    Peak dolly swing as a PERCENT of the viewing distance (15 → ±15%), which is what the slider shows. The control itself holds the fraction; see dollyAmplitudeFromPercent in controls/types.ts.

    autoDollyPeriod: number

    Seconds per full dolly oscillation.

    naturalDrag: boolean

    "Natural drag" — swap LEFT ↔ RIGHT mouse buttons in orbit mode so a one-finger touchpad drag rotates (and two-finger / right-drag pans). Defaults to true on macOS. Orbit (3D) only; ortho and fly modes ignore.

    orbitZoomSpeed?: number
    orbitDampingFactor?: number
    flyMovementSpeed?: number
    flyRotationSpeed?: number
    flyLookSpeed?: number
    flyInertialMode?: boolean
    flyDamping?: number
    flyRotationDamping?: number
    adaptiveDPREnabled: boolean
    allowHighDPR: boolean

    Whether the viewer may render above CSS resolution on a HiDPI display.

    densityGuardEnabled: boolean

    Runtime toggle for the projected-density guard (shader thinning of over-dense blendable nodes + the refinement rung cap). Persisted per scene; ?noDensityGuard overrides it for one session without touching the stored value.

    cinematicMode: boolean