Luxar Viewer API Documentation - v2026.9.22
    Preparing search index...

    Interface LuxarMaterial

    Type guard target: does this material have our update* methods?

    Deliberately does NOT extend CameraAwareMaterial, and that is a correction rather than a relaxation. Two independent reasons:

    1. The panel never calls updateCameraParams. Camera uniforms are broadcast by MaterialManager, not from here, so requiring the method described a dependency this interface does not have.
    2. isLuxarMaterial never checked for it. The guard tests updateIntensity + updateGamma only, and layer-apply.ts casts to LuxarMaterial on the strength of that — so the type was already over-claiming relative to the check that produces it.

    Mesh is what surfaced this: it is a real leaf material with the full layer-control surface, but it draws actual geometry and therefore has no screen-space extent to recompute, so it has no updateCameraParams at all. The tempting fix was an empty one on the material; that would be a lie, and would also cost a per-frame call per node if it ever joined the broadcast registry. Materials that ARE camera-aware still declare it via CameraAwareMaterial and are detected with isCameraAwareMaterial where it matters (the picking system does exactly this).

    interface LuxarMaterial {
        updateIntensity(v: number): void;
        updateOffset(v: number): void;
        updateGamma(v: number): void;
        updateOpacity(v: number): void;
        updateAbsorption?(v: number): void;
        updateAmbient?(v: number): void;
        updateShadeExponent?(v: number): void;
        updateSpecular?(v: number): void;
        updateShininess?(v: number): void;
        updateAlphaCutoff?(v: number): void;
        updatePhysicalKnob?(
            key:
                | "roughness"
                | "metalness"
                | "clearcoat"
                | "clearcoat_roughness"
                | "iridescence"
                | "sheen"
                | "transmission"
                | "ior"
                | "thickness"
                | "attenuation_distance"
                | "dispersion",
            value: number,
        ): void;
        updateRefractData?(refractData: boolean): void;
        updateColormapTexture?(texture: DataTexture | null): void;
        updateScalarRange?(min: number, max: number): void;
        updateLabelStyle?(colorByLabel: boolean, filterIndex: number): void;
        applyBlendingMode?(mode: BlendingModeName): void;
    }

    Hierarchy

    • Material
      • LuxarMaterial
    Index
    updateIntensity updateOffset updateGamma updateOpacity updateAbsorption? updateAmbient? updateShadeExponent? updateSpecular? updateShininess? updateAlphaCutoff? updatePhysicalKnob? updateRefractData? updateColormapTexture? updateScalarRange? updateLabelStyle? applyBlendingMode?

    • Update the absorption coefficient κ (volumetric blending mode). All three geometry-material families implement it (gsplats phase 1, points phase 3, lines phase 4); optional only for exotic/legacy materials (VOLUMETRIC_BLENDING_SPEC.md).

      Parameters

      • v: number

      Returns void

    • The §6.2 mesh appearance knobs: wrapped diffuse, specular, and the opaque-mode cutout threshold.

      Optional, and — unlike updateAbsorption above — genuinely so rather than for legacy reasons: only the mesh materials implement them, because mesh is the only geometry type that shades. The other three are emissive per-element sprites with no surface orientation, so there is no shade term for a floor to lift.

      That makes the optional-chained call site in applyMeshAppearance the type gate: a points material simply has no updateAmbient.

      Parameters

      • v: number

      Returns void

    • One physically based knob (material="physical" meshes only — the two wrappers in rendering/materials/mesh-physical/). Same optional-chained gate as the house knobs above: a house or emissive material simply lacks it.

      Parameters

      • key:
            | "roughness"
            | "metalness"
            | "clearcoat"
            | "clearcoat_roughness"
            | "iridescence"
            | "sheen"
            | "transmission"
            | "ior"
            | "thickness"
            | "attenuation_distance"
            | "dispersion"
      • value: number

      Returns void

    • Luxar refract_data (physical glass only, spec §3.4 Phase 3): draw the glass after the emissive data so it refracts it. Same optional-chained gate.

      Parameters

      • refractData: boolean

      Returns void

    • Parameters

      • colorByLabel: boolean
      • filterIndex: number

      Returns void

    • Apply a blending mode to this material in-place.

      All four geometry materials implement it today (the optionality is kept for exotic/legacy materials the generic fallback still covers). Call this instead of writing mat.blending/mat.blendEquation directly so type-specific factors, defines (LUXAR_VOLUMETRIC / LUXAR_MAX_RGB_CONTRIBUTION), and uniforms stay in sync.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods