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

    Variable PERF_COUNTERSConst

    PERF_COUNTERS: {
        "render.count": {
            unit: "count";
            kind: "sum";
            meaning: "scene renders issued; the sum of the render.byReason.* counters";
        };
        "render.ticks": {
            unit: "count";
            kind: "sum";
            meaning: "animation loop ticks";
        };
        "render.skippedTicks": {
            unit: "count";
            kind: "sum";
            meaning: "ticks render-on-change skipped because nothing drawn changed";
        };
        "render.once": {
            unit: "count";
            kind: "sum";
            meaning: "renderOnce() calls that resumed a stopped loop";
        };
        "render.missedDirty": {
            unit: "count";
            kind: "sum";
            meaning: "?renderAudit: a skipped frame whose pixels differed from the last render";
        };
        "render.auditCompares": {
            unit: "count";
            kind: "sum";
            meaning: "?renderAudit: skipped frames read back and compared";
        };
        "adaptiveDpr.samples": {
            unit: "count";
            kind: "sum";
            meaning: "frame times fed to the adaptive-DPR manager";
        };
        "playback.ticks": {
            unit: "count";
            kind: "sum";
            meaning: "playback ticks that advanced a dimension value";
        };
        "lod.levelSwaps": {
            unit: "count";
            kind: "sum";
            meaning: "displayed-level changes of a lod group (at most one per group per frame)";
        };
        "lod.blendFrames": {
            unit: "count";
            kind: "sum";
            meaning: "group-frames drawing two lod levels dissolving";
        };
        "partition.partsActivated": {
            unit: "count";
            kind: "sum";
            meaning: "deferred partition parts whose activation resolved";
        };
        "partition.partsInitialised": {
            unit: "count";
            kind: "sum";
            meaning: "partition parts whose subtree load resolved";
        };
        "scene.getObjectByName": {
            unit: "count";
            kind: "sum";
            meaning: "Object3D.getObjectByName calls (debug sessions only)";
        };
        "gpu.uploadCalls": {
            unit: "count";
            kind: "sum";
            meaning: "wrapped GPU upload calls";
        };
        "gpu.uploadBytes": {
            unit: "bytes";
            kind: "sum";
            meaning: "bytes uploaded to the GPU, buffers plus textures";
        };
        "gpu.uploadBytes.buffer": {
            unit: "bytes";
            kind: "sum";
            meaning: "buffer upload bytes";
        };
        "gpu.uploadBytes.texture": {
            unit: "bytes";
            kind: "sum";
            meaning: "texture upload bytes";
        };
        "loaders.swept": {
            unit: "count";
            kind: "sum";
            meaning: "loaders an update sweep considered (culled ones included), summed over sweeps";
        };
        "projection.gsplats.worker": {
            unit: "count";
            kind: "sum";
            meaning: "gsplats projections handed to the worker pool (a no-worker fallback included)";
        };
        "projection.gsplats.stageHits": {
            unit: "count";
            kind: "sum";
            meaning: "gsplats projections answered by the post-projection stage cache";
        };
        "projection.lines.worker": {
            unit: "count";
            kind: "sum";
            meaning: "lines projections handed to the worker pool (a no-worker fallback included)";
        };
        "projection.lines.stageHits": {
            unit: "count";
            kind: "sum";
            meaning: "lines projections answered by the post-projection stage cache";
        };
        "codec.blosc.worker": {
            unit: "count";
            kind: "sum";
            meaning: "Blosc chunk decodes a pool worker completed";
        };
        "codec.blosc.main": {
            unit: "count";
            kind: "sum";
            meaning: "Blosc chunk decodes run on the main thread (worker fallbacks included)";
        };
        "codec.blosc.fallback": {
            unit: "count";
            kind: "sum";
            meaning: "worker Blosc decodes that failed and fell back to the main thread";
        };
        "codec.delta.fused": {
            unit: "count";
            kind: "sum";
            meaning: "worker decodes that also undid the delta filter";
        };
        "worker.dispatches": {
            unit: "count";
            kind: "sum";
            meaning: "tasks sent to a pool worker";
        };
        "worker.busyMs": {
            unit: "ms";
            kind: "sum";
            meaning: "summed dispatch-to-settle time of pool tasks";
        };
        "worker.misroutes": {
            unit: "count";
            kind: "sum";
            meaning: "dispatches to a busy worker while another live worker was idle";
        };
        "l0.hits": {
            unit: "count";
            kind: "sum";
            meaning: "chunk lookups served from L0";
        };
        "l0.misses": {
            unit: "count";
            kind: "sum";
            meaning: "chunk lookups that started a decode";
        };
        "l0.coalesced": {
            unit: "count";
            kind: "sum";
            meaning: "chunk lookups that joined a decode already in flight";
        };
        "l0.cloneBytes": {
            unit: "bytes";
            kind: "sum";
            meaning: "bytes copied to store a decoded view that did not span its buffer";
        };
        "decode.count": {
            unit: "count";
            kind: "sum";
            meaning: "completed miss decodes";
        };
        "decode.bytes": {
            unit: "bytes";
            kind: "sum";
            meaning: "bytes of completed miss decodes";
        };
        "decode.duplicates": {
            unit: "count";
            kind: "sum";
            meaning: "re-decodes of a chunk decoded within the duplicate window";
        };
        "decode.count.foreground": {
            unit: "count";
            kind: "sum";
            meaning: "miss decodes a foreground load triggered";
        };
        "decode.count.shadow": {
            unit: "count";
            kind: "sum";
            meaning: "miss decodes a slice-prefetch shadow load triggered";
        };
        "decode.count.lookahead": {
            unit: "count";
            kind: "sum";
            meaning: "miss decodes a playback lookahead triggered";
        };
        "decode.count.prefetch": {
            unit: "count";
            kind: "sum";
            meaning: "miss decodes a chunk prefetch triggered";
        };
        "scache.pinnedEntries": {
            unit: "count";
            kind: "gauge";
            meaning: "S-cache entries currently protected by a prefetch pin";
        };
        "scache.pinnedBytes": {
            unit: "bytes";
            kind: "gauge";
            meaning: "retained bytes of the pinned S-cache entries";
        };
        "scache.stage.hits": {
            unit: "count";
            kind: "sum";
            meaning: "stage-output lookups answered from an S-cache entry";
        };
        "scache.stage.misses": {
            unit: "count";
            kind: "sum";
            meaning: "stage-output lookups on a resident payload that found no usable output";
        };
        "scache.stage.rejected": {
            unit: "count";
            kind: "sum";
            meaning: "stage outputs not admitted for lack of budget";
        };
        "scache.stage.shed": {
            unit: "count";
            kind: "sum";
            meaning: "stage outputs dropped to make room for slice data";
        };
        "scache.stage.bytes": {
            unit: "bytes";
            kind: "gauge";
            meaning: "bytes of stage outputs currently retained";
        };
        "l2.hits": {
            unit: "count";
            kind: "sum";
            meaning: "demand reads served from L2 (OPFS)";
        };
        "fetch.bytes": {
            unit: "bytes";
            kind: "sum";
            meaning: "response-body bytes the network tier materialised";
        };
        "fetch.data.requests": {
            unit: "count";
            kind: "sum";
            meaning: "gated data-lane fetches";
        };
        "fetch.data.highWater": {
            unit: "count";
            kind: "max";
            meaning: "most data-lane leases in flight at once";
        };
        "fetch.data.queueWaitMs": {
            unit: "ms";
            kind: "sum";
            meaning: "summed enqueue-to-start time of queued data-lane fetches";
        };
        "fetch.metadata.requests": {
            unit: "count";
            kind: "sum";
            meaning: "gated metadata-lane fetches";
        };
        "fetch.metadata.highWater": {
            unit: "count";
            kind: "max";
            meaning: "most metadata-lane leases in flight at once";
        };
        "fetch.metadata.queueWaitMs": {
            unit: "ms";
            kind: "sum";
            meaning: "summed enqueue-to-start time of queued metadata-lane fetches";
        };
        "opfs.writes": {
            unit: "count";
            kind: "sum";
            meaning: "successful OPFS chunk writes";
        };
        "opfs.writesDropped": {
            unit: "count";
            kind: "sum";
            meaning: "OPFS write arrivals dropped by an overflow policy";
        };
        "opfs.estimateCalls": {
            unit: "count";
            kind: "sum";
            meaning: "navigator.storage.estimate() quota checks";
        };
        "opfs.saveAttempts": {
            unit: "count";
            kind: "sum";
            meaning: "OPFS index save requests, debounced or not";
        };
        "opfs.indexSaves": {
            unit: "count";
            kind: "sum";
            meaning: "OPFS index files actually written";
        };
        "console.calls": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console calls";
        };
        "console.calls.log": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console.log calls";
        };
        "console.calls.warn": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console.warn calls";
        };
        "console.calls.error": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console.error calls";
        };
        "console.calls.info": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console.info calls";
        };
        "console.calls.debug": {
            unit: "count";
            kind: "sum";
            meaning: "intercepted console.debug calls";
        };
        "profiler.mergeMs": {
            unit: "ms";
            kind: "sum";
            meaning: "time merging finished profiler sessions into the persistent tree";
        };
    } = ...

    Every fixed perf counter. Adding a counter means adding it here (and an exact-value test, which counter-truth.test.ts enforces); a name that is not here does not compile.

    Type Declaration

    • Readonlyrender.count: {
          unit: "count";
          kind: "sum";
          meaning: "scene renders issued; the sum of the render.byReason.* counters";
      }
    • Readonlyrender.ticks: { unit: "count"; kind: "sum"; meaning: "animation loop ticks" }
    • Readonlyrender.skippedTicks: {
          unit: "count";
          kind: "sum";
          meaning: "ticks render-on-change skipped because nothing drawn changed";
      }
    • Readonlyrender.once: {
          unit: "count";
          kind: "sum";
          meaning: "renderOnce() calls that resumed a stopped loop";
      }
    • Readonlyrender.missedDirty: {
          unit: "count";
          kind: "sum";
          meaning: "?renderAudit: a skipped frame whose pixels differed from the last render";
      }
    • Readonlyrender.auditCompares: {
          unit: "count";
          kind: "sum";
          meaning: "?renderAudit: skipped frames read back and compared";
      }
    • ReadonlyadaptiveDpr.samples: {
          unit: "count";
          kind: "sum";
          meaning: "frame times fed to the adaptive-DPR manager";
      }
    • Readonlyplayback.ticks: {
          unit: "count";
          kind: "sum";
          meaning: "playback ticks that advanced a dimension value";
      }
    • Readonlylod.levelSwaps: {
          unit: "count";
          kind: "sum";
          meaning: "displayed-level changes of a lod group (at most one per group per frame)";
      }
    • Readonlylod.blendFrames: {
          unit: "count";
          kind: "sum";
          meaning: "group-frames drawing two lod levels dissolving";
      }
    • Readonlypartition.partsActivated: {
          unit: "count";
          kind: "sum";
          meaning: "deferred partition parts whose activation resolved";
      }
    • Readonlypartition.partsInitialised: {
          unit: "count";
          kind: "sum";
          meaning: "partition parts whose subtree load resolved";
      }
    • Readonlyscene.getObjectByName: {
          unit: "count";
          kind: "sum";
          meaning: "Object3D.getObjectByName calls (debug sessions only)";
      }
    • Readonlygpu.uploadCalls: { unit: "count"; kind: "sum"; meaning: "wrapped GPU upload calls" }
    • Readonlygpu.uploadBytes: {
          unit: "bytes";
          kind: "sum";
          meaning: "bytes uploaded to the GPU, buffers plus textures";
      }
    • Readonlygpu.uploadBytes.buffer: { unit: "bytes"; kind: "sum"; meaning: "buffer upload bytes" }
    • Readonlygpu.uploadBytes.texture: { unit: "bytes"; kind: "sum"; meaning: "texture upload bytes" }
    • Readonlyloaders.swept: {
          unit: "count";
          kind: "sum";
          meaning: "loaders an update sweep considered (culled ones included), summed over sweeps";
      }
    • Readonlyprojection.gsplats.worker: {
          unit: "count";
          kind: "sum";
          meaning: "gsplats projections handed to the worker pool (a no-worker fallback included)";
      }
    • Readonlyprojection.gsplats.stageHits: {
          unit: "count";
          kind: "sum";
          meaning: "gsplats projections answered by the post-projection stage cache";
      }
    • Readonlyprojection.lines.worker: {
          unit: "count";
          kind: "sum";
          meaning: "lines projections handed to the worker pool (a no-worker fallback included)";
      }
    • Readonlyprojection.lines.stageHits: {
          unit: "count";
          kind: "sum";
          meaning: "lines projections answered by the post-projection stage cache";
      }
    • Readonlycodec.blosc.worker: {
          unit: "count";
          kind: "sum";
          meaning: "Blosc chunk decodes a pool worker completed";
      }
    • Readonlycodec.blosc.main: {
          unit: "count";
          kind: "sum";
          meaning: "Blosc chunk decodes run on the main thread (worker fallbacks included)";
      }
    • Readonlycodec.blosc.fallback: {
          unit: "count";
          kind: "sum";
          meaning: "worker Blosc decodes that failed and fell back to the main thread";
      }
    • Readonlycodec.delta.fused: {
          unit: "count";
          kind: "sum";
          meaning: "worker decodes that also undid the delta filter";
      }
    • Readonlyworker.dispatches: { unit: "count"; kind: "sum"; meaning: "tasks sent to a pool worker" }
    • Readonlyworker.busyMs: {
          unit: "ms";
          kind: "sum";
          meaning: "summed dispatch-to-settle time of pool tasks";
      }
    • Readonlyworker.misroutes: {
          unit: "count";
          kind: "sum";
          meaning: "dispatches to a busy worker while another live worker was idle";
      }
    • Readonlyl0.hits: { unit: "count"; kind: "sum"; meaning: "chunk lookups served from L0" }
    • Readonlyl0.misses: { unit: "count"; kind: "sum"; meaning: "chunk lookups that started a decode" }
    • Readonlyl0.coalesced: {
          unit: "count";
          kind: "sum";
          meaning: "chunk lookups that joined a decode already in flight";
      }
    • Readonlyl0.cloneBytes: {
          unit: "bytes";
          kind: "sum";
          meaning: "bytes copied to store a decoded view that did not span its buffer";
      }
    • Readonlydecode.count: { unit: "count"; kind: "sum"; meaning: "completed miss decodes" }
    • Readonlydecode.bytes: { unit: "bytes"; kind: "sum"; meaning: "bytes of completed miss decodes" }
    • Readonlydecode.duplicates: {
          unit: "count";
          kind: "sum";
          meaning: "re-decodes of a chunk decoded within the duplicate window";
      }
    • Readonlydecode.count.foreground: {
          unit: "count";
          kind: "sum";
          meaning: "miss decodes a foreground load triggered";
      }
    • Readonlydecode.count.shadow: {
          unit: "count";
          kind: "sum";
          meaning: "miss decodes a slice-prefetch shadow load triggered";
      }
    • Readonlydecode.count.lookahead: {
          unit: "count";
          kind: "sum";
          meaning: "miss decodes a playback lookahead triggered";
      }
    • Readonlydecode.count.prefetch: {
          unit: "count";
          kind: "sum";
          meaning: "miss decodes a chunk prefetch triggered";
      }
    • Readonlyscache.pinnedEntries: {
          unit: "count";
          kind: "gauge";
          meaning: "S-cache entries currently protected by a prefetch pin";
      }
    • Readonlyscache.pinnedBytes: {
          unit: "bytes";
          kind: "gauge";
          meaning: "retained bytes of the pinned S-cache entries";
      }
    • Readonlyscache.stage.hits: {
          unit: "count";
          kind: "sum";
          meaning: "stage-output lookups answered from an S-cache entry";
      }
    • Readonlyscache.stage.misses: {
          unit: "count";
          kind: "sum";
          meaning: "stage-output lookups on a resident payload that found no usable output";
      }
    • Readonlyscache.stage.rejected: {
          unit: "count";
          kind: "sum";
          meaning: "stage outputs not admitted for lack of budget";
      }
    • Readonlyscache.stage.shed: {
          unit: "count";
          kind: "sum";
          meaning: "stage outputs dropped to make room for slice data";
      }
    • Readonlyscache.stage.bytes: {
          unit: "bytes";
          kind: "gauge";
          meaning: "bytes of stage outputs currently retained";
      }
    • Readonlyl2.hits: { unit: "count"; kind: "sum"; meaning: "demand reads served from L2 (OPFS)" }
    • Readonlyfetch.bytes: {
          unit: "bytes";
          kind: "sum";
          meaning: "response-body bytes the network tier materialised";
      }
    • Readonlyfetch.data.requests: { unit: "count"; kind: "sum"; meaning: "gated data-lane fetches" }
    • Readonlyfetch.data.highWater: {
          unit: "count";
          kind: "max";
          meaning: "most data-lane leases in flight at once";
      }
    • Readonlyfetch.data.queueWaitMs: {
          unit: "ms";
          kind: "sum";
          meaning: "summed enqueue-to-start time of queued data-lane fetches";
      }
    • Readonlyfetch.metadata.requests: { unit: "count"; kind: "sum"; meaning: "gated metadata-lane fetches" }
    • Readonlyfetch.metadata.highWater: {
          unit: "count";
          kind: "max";
          meaning: "most metadata-lane leases in flight at once";
      }
    • Readonlyfetch.metadata.queueWaitMs: {
          unit: "ms";
          kind: "sum";
          meaning: "summed enqueue-to-start time of queued metadata-lane fetches";
      }
    • Readonlyopfs.writes: { unit: "count"; kind: "sum"; meaning: "successful OPFS chunk writes" }
    • Readonlyopfs.writesDropped: {
          unit: "count";
          kind: "sum";
          meaning: "OPFS write arrivals dropped by an overflow policy";
      }
    • Readonlyopfs.estimateCalls: {
          unit: "count";
          kind: "sum";
          meaning: "navigator.storage.estimate() quota checks";
      }
    • Readonlyopfs.saveAttempts: {
          unit: "count";
          kind: "sum";
          meaning: "OPFS index save requests, debounced or not";
      }
    • Readonlyopfs.indexSaves: { unit: "count"; kind: "sum"; meaning: "OPFS index files actually written" }
    • Readonlyconsole.calls: { unit: "count"; kind: "sum"; meaning: "intercepted console calls" }
    • Readonlyconsole.calls.log: { unit: "count"; kind: "sum"; meaning: "intercepted console.log calls" }
    • Readonlyconsole.calls.warn: { unit: "count"; kind: "sum"; meaning: "intercepted console.warn calls" }
    • Readonlyconsole.calls.error: { unit: "count"; kind: "sum"; meaning: "intercepted console.error calls" }
    • Readonlyconsole.calls.info: { unit: "count"; kind: "sum"; meaning: "intercepted console.info calls" }
    • Readonlyconsole.calls.debug: { unit: "count"; kind: "sum"; meaning: "intercepted console.debug calls" }
    • Readonlyprofiler.mergeMs: {
          unit: "ms";
          kind: "sum";
          meaning: "time merging finished profiler sessions into the persistent tree";
      }