@miris-inc/core 0.0.8-5fc4d15 → 0.0.8-61fda5c

package/dist/core.d.ts

@@ -9,7 +9,9 @@ declare interface AttributeInfo extends EmbindObject {
     readonly elementCount: number;
     readonly dataSizeBytes: number;
     readonly clientSideId: bigint;
-    readonly minValue: { x: number; y: number; z: number };
+    // An embind CompressionType value, compared by identity against MainModule.CompressionType
+    readonly compressionType: unknown;
+    readonly minValue: { x: number; y: number; z: number; w: number };
     readonly maxValue: { x: number; y: number; z: number };
 }
 
@@ -32,7 +34,12 @@ export declare class AttributeNames {
     static readonly OCTANT_OFFSETS: string;
     static readonly SURFEL_OCTANT_OFFSETS: string;
     static readonly SURFEL_COUNT: string;
+    static readonly SURFEL_OWNER_GROUPS: string;
+    static readonly OCTANT_CELL: string;
     static readonly REFLECTANCE_DATA_V1: string;
+    static readonly REFLECTANCE_DATA_V2: string;
+    static readonly GLASS_MESH_GEOMETRY: string;
+    static readonly GLASS_MESH_PANELS: string;
     static readonly MOD_DEPTH: string;
 }
 
@@ -106,7 +113,9 @@ declare class Client {
     getSceneMetadata(...args: ClientMethodParameters["getSceneMetadata"]): number;
     getSceneObjectParent(...args: ClientMethodParameters["getSceneObjectParent"]): number;
     getSceneObjectType(...args: ClientMethodParameters["getSceneObjectType"]): SceneObjectType;
+    getStreamStatus(...args: ClientMethodParameters["getStreamStatus"]): StreamStatus;
     getDrawnOctantMask(...args: ClientMethodParameters["getDrawnOctantMask"]): number;
+    getOctantLocalBoundingBoxes(...args: ClientMethodParameters["getOctantLocalBoundingBoxes"]): number[];
     getLocalTransform(...args: ClientMethodParameters["getLocalTransform"]): AquaStatus;
     getWorldTransform(...args: ClientMethodParameters["getWorldTransform"]): AquaStatus;
     hasAttribute(...args: ClientMethodParameters["hasAttribute"]): boolean;
@@ -189,11 +198,23 @@ declare class Engine {
         readonly Loaded: 2;
         readonly Failed: 3;
     };
+    static StreamStatus: {
+        readonly Unknown: 0;
+        readonly Resolving: 1;
+        readonly Loading: 2;
+        readonly Ready: 3;
+        readonly Failed: 4;
+    };
     readonly ready: Promise<this>;
     readonly pending: boolean;
     get module(): MainModule;
     constructor(moduleOptions?: Record<string, unknown>);
     get AttributeInfo(): new () => AttributeInfo;
+    get CompressionType(): {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE_V2: unknown;
+    };
     get Handedness(): {
         Right: number;
         Left: number;
@@ -214,6 +235,7 @@ declare class Engine {
         Y: number;
         Z: number;
     };
+    get UsePadding(): boolean;
     activatedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     addStreamById(...args: [
     handle: AquaClientHandle,
@@ -231,6 +253,7 @@ declare class Engine {
     deactivatedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     remaskedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
     getDrawnOctantMask(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
+    getOctantLocalBoundingBoxes(...args: [handle: AquaClientHandle, sceneObjectId: number]): number[];
     destroyClient(...args: [handle: AquaClientHandle]): AquaStatus;
     free(...args: [size: number]): number;
     getAssetsAsync(...args: [handle: AquaClientHandle, tags: StringVector]): AssetInfo[];
@@ -249,6 +272,7 @@ declare class Engine {
     getSceneChangesCounts(...args: [handle: AquaClientHandle, sceneChangeIds: SceneChangeIds]): void;
     getSceneMetadata(...args: [handle: AquaClientHandle, metadata: SceneMetadata]): number;
     getSceneObjectParent(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
+    getStreamStatus(...args: [handle: AquaClientHandle, streamObjectId: number]): StreamStatus;
     getSceneObjectType(...args: [handle: AquaClientHandle, sceneObjectId: number]): SceneObjectType;
     getLocalTransform(...args: [
     handle: AquaClientHandle,
@@ -302,6 +326,7 @@ declare class Engine {
     ]): AquaStatus;
     setMaxCacheSize(...args: [maxSizeBytes: number]): void;
     setPreferSharkEncodingProfiles(...args: [preferShark: boolean]): void;
+    setPadSplatAttributes(usePadding: boolean): void;
     setSceneObjectTransform(...args: [
     handle: AquaClientHandle,
     sceneObjectId: number,
@@ -330,9 +355,16 @@ declare class Engine {
      * displayed frame per context, before the per-client updateSceneExecution() calls.
      * `previousFrameTimeMs` is how long the previous frame took; pass 0 when there is no plausible
      * measurement (first frame, or a resume from a stall) and the frame advances without recording
-     * one.
+     * `primsResident` is what the renderer held at the end of the previous frame, fading
+     * prims included, and `primCapacity` what it can hold; activations that would not fit are
+     * deferred, where primCapacity 0 means deferral is disabled.
      */
-    beginFrame(...args: [contextHandle: AquaContextHandle, previousFrameTimeMs: number]): AquaStatus;
+    beginFrame(...args: [
+    contextHandle: AquaContextHandle,
+    previousFrameTimeMs: number,
+    primsResident: number,
+    primCapacity: number
+    ]): AquaStatus;
     createDeserializeWorker(_url: string, _workerUrl: string, poolSize: number): boolean;
     cancelRequest(requestIdLow: number, requestIdHigh: number): boolean;
     submitToWorker(requestIdLow: number, requestIdHigh: number, descriptorBuffer: ArrayBuffer, contextPtr: number): boolean;
@@ -346,6 +378,12 @@ declare type EngineMethodParameters<E extends Engine = Engine> = {
     [Key in keyof E]: E[Key] extends (...args: any[]) => any ? Parameters<E[Key]> : never;
 };
 
+export declare const HaveData = 2;
+
+export declare const HaveMetadata = 1;
+
+export declare const HaveNothing = 0;
+
 export declare class Lod {
     #private;
     readonly id: LodInit["id"];
@@ -376,14 +414,19 @@ export declare class Lod {
     get transform(): Float32Array<ArrayBuffer> | null;
     get _drawnOctantMask(): number;
     set _drawnOctantMask(mask: number);
+    get _octantLocalBounds(): Float32Array<ArrayBuffer> | null;
+    set _octantLocalBounds(bounds: Float32Array<ArrayBuffer> | null);
     get _octantOffsets(): Uint32Array<ArrayBuffer> | null;
     get _hasOctantOffsets(): boolean;
     get _surfelOctantOffsets(): Uint32Array<ArrayBuffer> | null;
     get _surfelCount(): number;
+    get _surfelOwnerGroups(): Uint32Array<ArrayBuffer> | null;
+    get _octantCell(): Uint32Array<ArrayBuffer> | null;
     _readOctantOffsets(engine: Engine): void;
     hasAttribute(attributeName: string): boolean;
     getDataFromAttribute(engine: Engine, attributeName: string, attributeInfo: AttributeInfo): CachedAttribute | null;
     _getRawByteAttribute(engine: Engine, attributeName: string): Uint8Array<ArrayBuffer> | null;
+    _getRawByteAttributeWithBounds(engine: Engine, attributeName: string): RawByteAttributeWithBounds | null;
     dispose(): void;
     constructor({ id, modelRoot, lodStore, client }: LodInit);
 }
@@ -408,6 +451,11 @@ export declare class LodStore {
 
 declare interface MainModule {
     AttributeInfo: new () => AttributeInfo;
+    CompressionType: {
+        SHARK_ELLIPSOID_COMPRESSED: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
+        SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE_V2: unknown;
+    };
     Handedness: { Right: number; Left: number };
     HEAPF32: Float32Array<ArrayBuffer>;
     HEAPU8: Uint8Array<ArrayBuffer>;
@@ -436,6 +484,7 @@ declare interface MainModule {
     remaskedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     deletedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     GetDrawnOctantMask(handle: number, sceneObjectId: number): number;
+    GetOctantLocalBoundingBoxes(handle: number, sceneObjectId: number): number[];
     GetAssetsAsync(handle: number, tags: StringVector): unknown[];
     GetSceneChanges(handle: number, sceneChangeIds: SceneChangeIds): void;
     GetSceneChangesCounts(handle: number, sceneChangeIds: SceneChangeIds): void;
@@ -451,7 +500,12 @@ declare interface MainModule {
     TakeEvictedClientSideAttributeIds(handle: number): EmbindVector<bigint>;
     GetActiveClientSideIdsCheckSum(): number;
     TakeRenderRequired(handle: number): boolean;
-    BeginFrame(contextHandle: number, previousFrameTimeMs: number): number;
+    BeginFrame(
+    contextHandle: number,
+    previousFrameTimeMs: number,
+    primsResident: number,
+    primCapacity: number,
+    ): number;
     modifiedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
     setMaxCacheSize(maxSizeBytes: number): void;
     SetPreferSharkEncodingProfiles(prefer: boolean): void;
@@ -493,15 +547,20 @@ export declare class Miris {
     static readonly _XR_TARGET_FRAME_RATE = 43;
     /* Excluded from this release type: _XR_SPLAT_COUNT_BUDGET */
     /* Excluded from this release type: _SHARK_SPLAT_CAPACITY_MOBILE */
-    static readonly _SHARK_SPLAT_CAPACITY_DESKTOP = 3000000;
+    static readonly _SHARK_SPLAT_CAPACITY_DESKTOP: number;
     /* Excluded from this release type: _SHARK_SPLAT_BUDGET_CAP_MOBILE */
-    static readonly _SHARK_SPLAT_BUDGET_CAP_DESKTOP = 2500000;
+    static readonly _SHARK_SPLAT_BUDGET_CAP_DESKTOP = 2400000;
     /* Excluded from this release type: _isMobileDevice */
     /* Excluded from this release type: _sharkSplatCapacity */
+    /* Excluded from this release type: _minimumSplatCount */
+    /* Excluded from this release type: _splatCountStorageKey */
+    /* Excluded from this release type: _reloadWithLowerSplatCapacity */
+    /* Excluded from this release type: _limitSharkSplatCapacity */
     /* Excluded from this release type: _sharkSplatBudgetCap */
     /* Excluded from this release type: _setTargetFrameRate */
     /* Excluded from this release type: _setXRModeActive */
     /* Excluded from this release type: _setSplatCountBudgetOverride */
+    /* Excluded from this release type: _reportRendererPrims */
     /* Excluded from this release type: _update */
     getLocalTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
     getWorldTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
@@ -534,6 +593,31 @@ export declare type ModelRootInit = {
     stream: Stream;
 };
 
+/**
+ * The byte-exact counterpart of getRawUint32Attribute above: same no-padding, no-takeAttribute
+ * contract, returning bytes rather than words.
+ *
+ * Use this rather than that one wherever the stride is not a whole number of words: the
+ * reflectance records' 18- and 26-byte strides are not, and an odd record count would lose that
+ * record's last field to dataPtrView's truncation.
+ */
+export declare type RawByteAttributeWithBounds = {
+    bytes: Uint8Array<ArrayBuffer>;
+    minValue: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    maxValue: {
+        x: number;
+        y: number;
+        z: number;
+    };
+};
+
+declare type ReadyState_2 = typeof HaveNothing | typeof HaveMetadata | typeof HaveData;
+export { ReadyState_2 as ReadyState }
+
 declare type RequestAnimationFrameFn = ((callback: FrameRequestCallback) => number) | ((callback: XRFrameRequestCallback) => void);
 
 declare interface RuntimeSettings extends EmbindObject {
@@ -592,6 +676,7 @@ export declare class Scene extends EventTarget {
     /* Excluded from this release type: _getDrMap */
     /* Excluded from this release type: _onDrMapLadder */
     /* Excluded from this release type: _onFeatureData */
+    /* Excluded from this release type: _updateStreamStatuses */
     /* Excluded from this release type: _onSceneLoaded */
     delete(stream: Stream): void;
     close(): void;
@@ -683,6 +768,9 @@ export declare class Stream extends EventTarget {
     /* Excluded from this release type: _onStreamLoaded */
     getDefaultCameraTransform(): Float32Array<ArrayBuffer> | null | undefined;
     /* Excluded from this release type: _getViewingVolumeObb */
+    /** How much of the stream has loaded, as of the last frame. */
+    get readyState(): ReadyState_2;
+    /* Excluded from this release type: _updateStatus */
     /* Excluded from this release type: _onRootLoaded */
     add(modelRoot: ModelRoot): void;
     end(): void;