@miris-inc/core 0.0.8-959f88f → 0.0.8-98048ea
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/AquaApi.wasm +0 -0
- package/dist/aqua-parser.wasm +0 -0
- package/dist/core.d.ts +197 -43
- package/dist/core.js +2458 -2192
- package/dist/core.prod.js +1 -1
- package/dist/core.standalone.js +6101 -5127
- package/dist/core.standalone.prod.js +1 -1
- package/package.json +23 -16
- package/webshark.d.ts +318 -0
- package/dist/AquaApi.js +0 -15
- package/dist/aqua-parser.js +0 -14
package/dist/AquaApi.wasm
CHANGED
|
Binary file
|
package/dist/aqua-parser.wasm
CHANGED
|
Binary file
|
package/dist/core.d.ts
CHANGED
|
@@ -1,16 +1,58 @@
|
|
|
1
|
+
export declare const AssetFormat: {
|
|
2
|
+
readonly GaussianSplats: 1;
|
|
3
|
+
readonly GES: 2;
|
|
4
|
+
};
|
|
5
|
+
|
|
1
6
|
declare interface AttributeInfo extends EmbindObject {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
readonly
|
|
5
|
-
readonly
|
|
7
|
+
// Logical elements from the drop metadata: splats for a per-splat attribute, records for a
|
|
8
|
+
// per-surfel one. Not necessarily dataSizeBytes / bytesPerElement.
|
|
9
|
+
readonly elementCount: number;
|
|
10
|
+
readonly dataSizeBytes: number;
|
|
6
11
|
readonly clientSideId: bigint;
|
|
12
|
+
// An embind CompressionType value, compared by identity against MainModule.CompressionType
|
|
13
|
+
readonly compressionType: unknown;
|
|
14
|
+
readonly minValue: { x: number; y: number; z: number; w: number };
|
|
7
15
|
readonly maxValue: { x: number; y: number; z: number };
|
|
8
16
|
}
|
|
9
17
|
|
|
18
|
+
export declare class AttributeNames {
|
|
19
|
+
static readonly SPARK_PACKED_SPLAT: string;
|
|
20
|
+
static readonly SPARK_EXTENDED_SPLAT_LOW: string;
|
|
21
|
+
static readonly SPARK_EXTENDED_SPLAT_HIGH: string;
|
|
22
|
+
static readonly SPARK_PACKED_SH1: string;
|
|
23
|
+
static readonly SPARK_PACKED_SH2: string;
|
|
24
|
+
static readonly SPARK_PACKED_SH3: string;
|
|
25
|
+
static readonly SPARK_EXTENDED_SH1: string;
|
|
26
|
+
static readonly SPARK_EXTENDED_SH2: string;
|
|
27
|
+
static readonly SPARK_EXTENDED_SH3_A: string;
|
|
28
|
+
static readonly SPARK_EXTENDED_SH3_B: string;
|
|
29
|
+
static readonly UNUSED: string;
|
|
30
|
+
static readonly SHARK_ELLIPSOIDS: string;
|
|
31
|
+
static readonly SHARK_ELLIPSOIDS_COMPRESSED: string;
|
|
32
|
+
static readonly SHARK_SPHERICAL_HARMONICS: string;
|
|
33
|
+
static readonly COLOR: string;
|
|
34
|
+
static readonly OCTANT_OFFSETS: string;
|
|
35
|
+
static readonly SURFEL_OCTANT_OFFSETS: string;
|
|
36
|
+
static readonly SURFEL_COUNT: string;
|
|
37
|
+
static readonly SURFEL_OWNER_GROUPS: string;
|
|
38
|
+
static readonly OCTANT_CELL: string;
|
|
39
|
+
static readonly REFLECTANCE_DATA_V1: string;
|
|
40
|
+
static readonly GLASS_MESH_GEOMETRY: string;
|
|
41
|
+
static readonly GLASS_MESH_PANELS: string;
|
|
42
|
+
static readonly MOD_DEPTH: string;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
declare type CachedAttribute = {
|
|
46
|
+
paddedData: Uint32Array<ArrayBuffer>;
|
|
47
|
+
originalSizeInUints: number;
|
|
48
|
+
};
|
|
49
|
+
|
|
10
50
|
export declare class Camera {
|
|
11
51
|
#private;
|
|
12
52
|
readonly id: number;
|
|
13
53
|
update(): void;
|
|
54
|
+
get viewportHeight(): number;
|
|
55
|
+
set viewportHeight(viewportHeight: number);
|
|
14
56
|
get aspect(): number;
|
|
15
57
|
set aspect(aspect: number);
|
|
16
58
|
get fov(): number;
|
|
@@ -24,7 +66,7 @@ export declare class Camera {
|
|
|
24
66
|
readonly engine: Engine;
|
|
25
67
|
readonly miris: Miris;
|
|
26
68
|
readonly scene: Scene;
|
|
27
|
-
constructor({ aspect, fov, near, far, matrix, scene }: CameraInit);
|
|
69
|
+
constructor({ aspect, fov, near, far, matrix, scene, viewportHeight, }: CameraInit);
|
|
28
70
|
}
|
|
29
71
|
|
|
30
72
|
export declare type CameraInit = {
|
|
@@ -34,6 +76,7 @@ export declare type CameraInit = {
|
|
|
34
76
|
far: number;
|
|
35
77
|
matrix: Matrix4x4Tuple;
|
|
36
78
|
scene: Scene;
|
|
79
|
+
viewportHeight?: number;
|
|
37
80
|
};
|
|
38
81
|
|
|
39
82
|
export declare class Change {
|
|
@@ -43,7 +86,7 @@ export declare class Change {
|
|
|
43
86
|
}
|
|
44
87
|
|
|
45
88
|
export declare type ChangeInit = {
|
|
46
|
-
type: "created" | "activated" | "modified" | "deactivated" | "deleted";
|
|
89
|
+
type: "created" | "activated" | "modified" | "deactivated" | "deleted" | "remasked";
|
|
47
90
|
lod: Lod;
|
|
48
91
|
};
|
|
49
92
|
|
|
@@ -60,6 +103,7 @@ declare class Client {
|
|
|
60
103
|
getAssetsAsync(...args: ClientMethodParameters["getAssetsAsync"]): AssetInfo[];
|
|
61
104
|
getAttribute(...args: ClientMethodParameters["getAttribute"]): AquaStatus;
|
|
62
105
|
getDefaultCameraId(...args: ClientMethodParameters["getDefaultCameraId"]): number;
|
|
106
|
+
getViewingVolumeId(...args: ClientMethodParameters["getViewingVolumeId"]): number;
|
|
63
107
|
getLocalBoundingBox(...args: ClientMethodParameters["getLocalBoundingBox"]): AquaStatus;
|
|
64
108
|
getWorldBoundingBox(...args: ClientMethodParameters["getWorldBoundingBox"]): AquaStatus;
|
|
65
109
|
getLodIndex(...args: ClientMethodParameters["getLodIndex"]): number;
|
|
@@ -68,6 +112,7 @@ declare class Client {
|
|
|
68
112
|
getSceneMetadata(...args: ClientMethodParameters["getSceneMetadata"]): number;
|
|
69
113
|
getSceneObjectParent(...args: ClientMethodParameters["getSceneObjectParent"]): number;
|
|
70
114
|
getSceneObjectType(...args: ClientMethodParameters["getSceneObjectType"]): SceneObjectType;
|
|
115
|
+
getDrawnOctantMask(...args: ClientMethodParameters["getDrawnOctantMask"]): number;
|
|
71
116
|
getLocalTransform(...args: ClientMethodParameters["getLocalTransform"]): AquaStatus;
|
|
72
117
|
getWorldTransform(...args: ClientMethodParameters["getWorldTransform"]): AquaStatus;
|
|
73
118
|
hasAttribute(...args: ClientMethodParameters["hasAttribute"]): boolean;
|
|
@@ -83,6 +128,8 @@ declare class Client {
|
|
|
83
128
|
hasFeature(...args: ClientMethodParameters["hasFeature"]): boolean;
|
|
84
129
|
getFeatureVersion(...args: ClientMethodParameters["getFeatureVersion"]): number;
|
|
85
130
|
getFeatureState(...args: ClientMethodParameters["getFeatureState"]): number;
|
|
131
|
+
getAssetFormatVersion(...args: ClientMethodParameters["getAssetFormatVersion"]): number;
|
|
132
|
+
getDrMapLadderRoughnessLevels(...args: ClientMethodParameters["getDrMapLadderRoughnessLevels"]): number[];
|
|
86
133
|
getName(...args: ClientMethodParameters["getName"]): string;
|
|
87
134
|
setVariantSelection(...args: ClientMethodParameters["setVariantSelection"]): AquaStatus;
|
|
88
135
|
takeAttribute(...args: ClientMethodParameters["takeAttribute"]): AquaStatus;
|
|
@@ -90,7 +137,6 @@ declare class Client {
|
|
|
90
137
|
takeRenderRequired(...args: ClientMethodParameters["takeRenderRequired"]): boolean;
|
|
91
138
|
unlockScene(...args: ClientMethodParameters["unlockScene"]): boolean;
|
|
92
139
|
updateSceneExecution(...args: ClientMethodParameters["updateSceneExecution"]): AquaStatus;
|
|
93
|
-
recordFrameTime(...args: ClientMethodParameters["recordFrameTime"]): AquaStatus;
|
|
94
140
|
}
|
|
95
141
|
|
|
96
142
|
declare type ClientInit = {
|
|
@@ -140,6 +186,8 @@ declare class Engine {
|
|
|
140
186
|
};
|
|
141
187
|
static Feature: {
|
|
142
188
|
readonly DrMap: 0;
|
|
189
|
+
readonly ReflMesh: 1;
|
|
190
|
+
readonly GlassMesh: 2;
|
|
143
191
|
};
|
|
144
192
|
static FeatureState: {
|
|
145
193
|
readonly NotLoaded: 0;
|
|
@@ -152,6 +200,10 @@ declare class Engine {
|
|
|
152
200
|
get module(): MainModule;
|
|
153
201
|
constructor(moduleOptions?: Record<string, unknown>);
|
|
154
202
|
get AttributeInfo(): new () => AttributeInfo;
|
|
203
|
+
get CompressionType(): {
|
|
204
|
+
SHARK_ELLIPSOID_COMPRESSED: unknown;
|
|
205
|
+
SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
|
|
206
|
+
};
|
|
155
207
|
get Handedness(): {
|
|
156
208
|
Right: number;
|
|
157
209
|
Left: number;
|
|
@@ -187,6 +239,8 @@ declare class Engine {
|
|
|
187
239
|
deletedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
|
|
188
240
|
dataPtrView(...args: [attributeInfo: AttributeInfo]): Uint32Array;
|
|
189
241
|
deactivatedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
|
|
242
|
+
remaskedObjectIdsView(...args: [sceneChangeIds: SceneChangeIds]): Uint32Array;
|
|
243
|
+
getDrawnOctantMask(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
|
|
190
244
|
destroyClient(...args: [handle: AquaClientHandle]): AquaStatus;
|
|
191
245
|
free(...args: [size: number]): number;
|
|
192
246
|
getAssetsAsync(...args: [handle: AquaClientHandle, tags: StringVector]): AssetInfo[];
|
|
@@ -196,7 +250,8 @@ declare class Engine {
|
|
|
196
250
|
attributeName: string,
|
|
197
251
|
attributeInfo: AttributeInfo
|
|
198
252
|
]): AquaStatus;
|
|
199
|
-
getDefaultCameraId(...args: [handle: AquaClientHandle]): number;
|
|
253
|
+
getDefaultCameraId(...args: [handle: AquaClientHandle, streamObjectId: number]): number;
|
|
254
|
+
getViewingVolumeId(...args: [handle: AquaClientHandle, streamObjectId: number]): number;
|
|
200
255
|
getLocalBoundingBox(...args: [handle: AquaClientHandle, sceneObjectId: number, boxData: number]): AquaStatus;
|
|
201
256
|
getWorldBoundingBox(...args: [handle: AquaClientHandle, sceneObjectId: number, boxData: number]): AquaStatus;
|
|
202
257
|
getLodIndex(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
|
|
@@ -245,19 +300,18 @@ declare class Engine {
|
|
|
245
300
|
removeStream(...args: [handle: AquaClientHandle, streamObjectId: number]): boolean;
|
|
246
301
|
setAssetViewerKey(...args: [handle: AquaClientHandle, key: string]): AquaStatus;
|
|
247
302
|
setClientSpatialFormat(...args: [handle: AquaClientHandle, spatialFormat: SpatialFormat]): AquaStatus;
|
|
248
|
-
setRuntimeSettings(...args: [
|
|
249
|
-
handle: AquaClientHandle,
|
|
250
|
-
settings: RuntimeSettings
|
|
251
|
-
]): AquaStatus;
|
|
303
|
+
setRuntimeSettings(...args: [handle: AquaClientHandle, settings: RuntimeSettings]): AquaStatus;
|
|
252
304
|
setMainCameraTransform(...args: [handle: AquaClientHandle, cameraTransform: number]): AquaStatus;
|
|
253
305
|
setMainCameraViewFrustum(...args: [
|
|
254
306
|
handle: AquaClientHandle,
|
|
255
307
|
aspectRatio: number,
|
|
256
308
|
verticalFov: number,
|
|
257
309
|
nearPlane: number,
|
|
258
|
-
farPlane: number
|
|
310
|
+
farPlane: number,
|
|
311
|
+
viewportHeightPixels: number
|
|
259
312
|
]): AquaStatus;
|
|
260
313
|
setMaxCacheSize(...args: [maxSizeBytes: number]): void;
|
|
314
|
+
setPreferSharkEncodingProfiles(...args: [preferShark: boolean]): void;
|
|
261
315
|
setSceneObjectTransform(...args: [
|
|
262
316
|
handle: AquaClientHandle,
|
|
263
317
|
sceneObjectId: number,
|
|
@@ -266,14 +320,10 @@ declare class Engine {
|
|
|
266
320
|
hasFeature(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): boolean;
|
|
267
321
|
getFeatureVersion(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): number;
|
|
268
322
|
getFeatureState(...args: [handle: AquaClientHandle, sceneObjectId: number, feature: number]): number;
|
|
269
|
-
|
|
270
|
-
handle: AquaClientHandle,
|
|
271
|
-
sceneObjectId: number
|
|
272
|
-
]):
|
|
273
|
-
setVariantSelection(...args: [
|
|
274
|
-
handle: AquaClientHandle,
|
|
275
|
-
sceneObjectId: number
|
|
276
|
-
]): AquaStatus;
|
|
323
|
+
getDrMapLadderRoughnessLevels(...args: [handle: AquaClientHandle, sceneObjectId: number]): number[];
|
|
324
|
+
getAssetFormatVersion(...args: [handle: AquaClientHandle, sceneObjectId: number]): number;
|
|
325
|
+
getName(...args: [handle: AquaClientHandle, sceneObjectId: number]): string;
|
|
326
|
+
setVariantSelection(...args: [handle: AquaClientHandle, sceneObjectId: number]): AquaStatus;
|
|
277
327
|
takeAttribute(...args: [
|
|
278
328
|
handle: AquaClientHandle,
|
|
279
329
|
sceneObjectId: number,
|
|
@@ -284,8 +334,15 @@ declare class Engine {
|
|
|
284
334
|
getActiveClientSideIdsCheckSum(): number;
|
|
285
335
|
unlockScene(...args: [handle: AquaClientHandle]): boolean;
|
|
286
336
|
updateSceneExecution(...args: [handle: AquaClientHandle]): AquaStatus;
|
|
287
|
-
recordFrameTime(...args: [handle: AquaClientHandle, frameTimeMs: number]): AquaStatus;
|
|
288
337
|
takeRenderRequired(...args: [handle: AquaClientHandle]): boolean;
|
|
338
|
+
/**
|
|
339
|
+
* Advances the runtime by one frame and recomputes the streaming budget. Call once per
|
|
340
|
+
* displayed frame per context, before the per-client updateSceneExecution() calls.
|
|
341
|
+
* `previousFrameTimeMs` is how long the previous frame took; pass 0 when there is no plausible
|
|
342
|
+
* measurement (first frame, or a resume from a stall) and the frame advances without recording
|
|
343
|
+
* one.
|
|
344
|
+
*/
|
|
345
|
+
beginFrame(...args: [contextHandle: AquaContextHandle, previousFrameTimeMs: number]): AquaStatus;
|
|
289
346
|
createDeserializeWorker(_url: string, _workerUrl: string, poolSize: number): boolean;
|
|
290
347
|
cancelRequest(requestIdLow: number, requestIdHigh: number): boolean;
|
|
291
348
|
submitToWorker(requestIdLow: number, requestIdHigh: number, descriptorBuffer: ArrayBuffer, contextPtr: number): boolean;
|
|
@@ -303,41 +360,52 @@ export declare class Lod {
|
|
|
303
360
|
#private;
|
|
304
361
|
readonly id: LodInit["id"];
|
|
305
362
|
readonly store: LodStore;
|
|
306
|
-
useExtSplats: boolean;
|
|
307
|
-
splatsExtendedData: Uint32Array<ArrayBuffer> | null;
|
|
308
|
-
sh1Data: Uint32Array<ArrayBuffer> | null;
|
|
309
|
-
sh1Max: number;
|
|
310
|
-
sh2Data: Uint32Array<ArrayBuffer> | null;
|
|
311
|
-
sh2Max: number;
|
|
312
|
-
sh3Data: Uint32Array<ArrayBuffer> | null;
|
|
313
|
-
sh3Max: number;
|
|
314
|
-
sh3ExtendedData: Uint32Array<ArrayBuffer> | null;
|
|
315
363
|
get key(): unknown;
|
|
316
364
|
set key(key: unknown);
|
|
317
365
|
readonly modelRoot: ModelRoot;
|
|
318
|
-
set splats(splats: Uint32Array<ArrayBuffer> | null);
|
|
319
|
-
get splats(): Uint32Array<ArrayBuffer> | null;
|
|
320
366
|
set bounds(bounds: Float32Array<ArrayBuffer> | null);
|
|
367
|
+
/**
|
|
368
|
+
* Retrieves the cached world bounds of this object
|
|
369
|
+
*
|
|
370
|
+
* @deprecated Retrieve the local bounds and transform as needed
|
|
371
|
+
*/
|
|
321
372
|
get bounds(): Float32Array<ArrayBuffer> | null;
|
|
322
|
-
|
|
323
|
-
|
|
373
|
+
/**
|
|
374
|
+
* Sets the local bounds of this lod
|
|
375
|
+
*/
|
|
376
|
+
set localBounds(bounds: Float32Array<ArrayBuffer> | null);
|
|
377
|
+
/**
|
|
378
|
+
* Retrieves the local bounds of this lod
|
|
379
|
+
*/
|
|
380
|
+
get localBounds(): Float32Array<ArrayBuffer> | null;
|
|
324
381
|
set lodIndex(index: number);
|
|
325
382
|
get lodIndex(): number | null;
|
|
326
|
-
set
|
|
327
|
-
get
|
|
383
|
+
set paddingSplatsCount(count: number);
|
|
384
|
+
get paddingSplatsCount(): number;
|
|
328
385
|
set transform(transform: Float32Array<ArrayBuffer> | null);
|
|
329
386
|
get transform(): Float32Array<ArrayBuffer> | null;
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
387
|
+
get _drawnOctantMask(): number;
|
|
388
|
+
set _drawnOctantMask(mask: number);
|
|
389
|
+
get _octantOffsets(): Uint32Array<ArrayBuffer> | null;
|
|
390
|
+
get _hasOctantOffsets(): boolean;
|
|
391
|
+
get _surfelOctantOffsets(): Uint32Array<ArrayBuffer> | null;
|
|
392
|
+
get _surfelCount(): number;
|
|
393
|
+
get _surfelOwnerGroups(): Uint32Array<ArrayBuffer> | null;
|
|
394
|
+
get _octantCell(): Uint32Array<ArrayBuffer> | null;
|
|
395
|
+
_readOctantOffsets(engine: Engine): void;
|
|
396
|
+
hasAttribute(attributeName: string): boolean;
|
|
397
|
+
getDataFromAttribute(engine: Engine, attributeName: string, attributeInfo: AttributeInfo): CachedAttribute | null;
|
|
398
|
+
_getRawByteAttribute(engine: Engine, attributeName: string): Uint8Array<ArrayBuffer> | null;
|
|
399
|
+
_getRawByteAttributeWithBounds(engine: Engine, attributeName: string): RawByteAttributeWithBounds | null;
|
|
333
400
|
dispose(): void;
|
|
334
|
-
constructor({ id, modelRoot, lodStore }: LodInit);
|
|
401
|
+
constructor({ id, modelRoot, lodStore, client }: LodInit);
|
|
335
402
|
}
|
|
336
403
|
|
|
337
404
|
export declare type LodInit = {
|
|
338
405
|
id: number;
|
|
339
406
|
modelRoot: ModelRoot;
|
|
340
407
|
lodStore: LodStore;
|
|
408
|
+
client: Client;
|
|
341
409
|
};
|
|
342
410
|
|
|
343
411
|
export declare class LodStore {
|
|
@@ -353,6 +421,10 @@ export declare class LodStore {
|
|
|
353
421
|
|
|
354
422
|
declare interface MainModule {
|
|
355
423
|
AttributeInfo: new () => AttributeInfo;
|
|
424
|
+
CompressionType: {
|
|
425
|
+
SHARK_ELLIPSOID_COMPRESSED: unknown;
|
|
426
|
+
SHARK_ELLIPSOID_COMPRESSED_ROOT_RELATIVE: unknown;
|
|
427
|
+
};
|
|
356
428
|
Handedness: { Right: number; Left: number };
|
|
357
429
|
HEAPF32: Float32Array<ArrayBuffer>;
|
|
358
430
|
HEAPU8: Uint8Array<ArrayBuffer>;
|
|
@@ -378,7 +450,9 @@ declare interface MainModule {
|
|
|
378
450
|
createdObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
|
|
379
451
|
dataPtrView(attributeInfo: AttributeInfo): Uint32Array;
|
|
380
452
|
deactivatedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
|
|
453
|
+
remaskedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
|
|
381
454
|
deletedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
|
|
455
|
+
GetDrawnOctantMask(handle: number, sceneObjectId: number): number;
|
|
382
456
|
GetAssetsAsync(handle: number, tags: StringVector): unknown[];
|
|
383
457
|
GetSceneChanges(handle: number, sceneChangeIds: SceneChangeIds): void;
|
|
384
458
|
GetSceneChangesCounts(handle: number, sceneChangeIds: SceneChangeIds): void;
|
|
@@ -387,13 +461,17 @@ declare interface MainModule {
|
|
|
387
461
|
HasFeature(handle: number, sceneObjectId: number, feature: number): boolean;
|
|
388
462
|
GetFeatureVersion(handle: number, sceneObjectId: number, feature: number): number;
|
|
389
463
|
GetFeatureState(handle: number, sceneObjectId: number, feature: number): number;
|
|
464
|
+
GetAssetFormatVersion(handle: number, sceneObjectId: number): number;
|
|
465
|
+
GetDrMapLadderRoughnessLevels(handle: number, sceneObjectId: number): number[];
|
|
390
466
|
SetClientSpatialFormat(handle: number, spatialFormat: SpatialFormat): { value: number };
|
|
391
467
|
SetRuntimeSettings(handle: number, settings: RuntimeSettings): { value: number };
|
|
392
468
|
TakeEvictedClientSideAttributeIds(handle: number): EmbindVector<bigint>;
|
|
393
469
|
GetActiveClientSideIdsCheckSum(): number;
|
|
394
470
|
TakeRenderRequired(handle: number): boolean;
|
|
471
|
+
BeginFrame(contextHandle: number, previousFrameTimeMs: number): number;
|
|
395
472
|
modifiedObjectIdsView(sceneChangeIds: SceneChangeIds): Uint32Array;
|
|
396
473
|
setMaxCacheSize(maxSizeBytes: number): void;
|
|
474
|
+
SetPreferSharkEncodingProfiles(prefer: boolean): void;
|
|
397
475
|
}
|
|
398
476
|
|
|
399
477
|
/**
|
|
@@ -406,6 +484,7 @@ declare interface MainModule {
|
|
|
406
484
|
*/
|
|
407
485
|
export declare class Miris {
|
|
408
486
|
#private;
|
|
487
|
+
static tryUseShark: boolean;
|
|
409
488
|
static _instance: Miris;
|
|
410
489
|
static instance<T extends typeof Miris>(this: T): Promise<InstanceType<T>>;
|
|
411
490
|
readonly engine: Engine;
|
|
@@ -415,14 +494,36 @@ export declare class Miris {
|
|
|
415
494
|
get viewerKey(): string | null | undefined;
|
|
416
495
|
set viewerKey(viewerKey: string | null | undefined);
|
|
417
496
|
get scenes(): Set<Scene>;
|
|
497
|
+
get useSphericalHarmonics(): boolean;
|
|
498
|
+
set useSphericalHarmonics(value: boolean);
|
|
418
499
|
constructor();
|
|
419
500
|
dispose(): void;
|
|
420
501
|
updateParentedTransform(_modelTransform: Float32Array<ArrayBuffer>, _parentTransform: Float32Array<ArrayBuffer>): Float32Array<ArrayBuffer> | undefined;
|
|
502
|
+
protected _xrModeActive: boolean;
|
|
503
|
+
protected _xrSession: XRSession | null;
|
|
504
|
+
protected _requestAnimationFrame: RequestAnimationFrameFn | null;
|
|
505
|
+
signalResumeFromIdle(): void;
|
|
506
|
+
get _splatCountBudget(): number;
|
|
507
|
+
/**
|
|
508
|
+
* Why 43? Because the AVP throttles down to 45Hz :(
|
|
509
|
+
*/
|
|
510
|
+
static readonly _XR_TARGET_FRAME_RATE = 43;
|
|
511
|
+
/* Excluded from this release type: _XR_SPLAT_COUNT_BUDGET */
|
|
512
|
+
/* Excluded from this release type: _SHARK_SPLAT_CAPACITY_MOBILE */
|
|
513
|
+
static readonly _SHARK_SPLAT_CAPACITY_DESKTOP = 3000000;
|
|
514
|
+
/* Excluded from this release type: _SHARK_SPLAT_BUDGET_CAP_MOBILE */
|
|
515
|
+
static readonly _SHARK_SPLAT_BUDGET_CAP_DESKTOP = 2500000;
|
|
516
|
+
/* Excluded from this release type: _isMobileDevice */
|
|
517
|
+
/* Excluded from this release type: _sharkSplatCapacity */
|
|
518
|
+
/* Excluded from this release type: _limitSharkSplatCapacity */
|
|
519
|
+
/* Excluded from this release type: _sharkSplatBudgetCap */
|
|
520
|
+
/* Excluded from this release type: _setTargetFrameRate */
|
|
421
521
|
/* Excluded from this release type: _setXRModeActive */
|
|
522
|
+
/* Excluded from this release type: _setSplatCountBudgetOverride */
|
|
422
523
|
/* Excluded from this release type: _update */
|
|
423
524
|
getLocalTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
|
|
424
525
|
getWorldTransform(client: Client, sceneObjectId: number): Float32Array<ArrayBuffer> | undefined;
|
|
425
|
-
|
|
526
|
+
/* Excluded from this release type: _updateForScene */
|
|
426
527
|
applyChanges(_entries: Change[]): void;
|
|
427
528
|
_computeAdditionalRenderNeeded(): boolean;
|
|
428
529
|
onColorSpaceDetected(_isLinear: boolean): void;
|
|
@@ -451,11 +552,37 @@ export declare type ModelRootInit = {
|
|
|
451
552
|
stream: Stream;
|
|
452
553
|
};
|
|
453
554
|
|
|
555
|
+
/**
|
|
556
|
+
* The byte-exact counterpart of getRawUint32Attribute above: same no-padding, no-takeAttribute
|
|
557
|
+
* contract, returning bytes rather than words.
|
|
558
|
+
*
|
|
559
|
+
* Use this rather than that one wherever the stride is not a whole number of words:
|
|
560
|
+
* reflectanceDataV1's 26-byte record is not, and an odd record count would lose that record's
|
|
561
|
+
* last field to dataPtrView's truncation.
|
|
562
|
+
*/
|
|
563
|
+
export declare type RawByteAttributeWithBounds = {
|
|
564
|
+
bytes: Uint8Array<ArrayBuffer>;
|
|
565
|
+
minValue: {
|
|
566
|
+
x: number;
|
|
567
|
+
y: number;
|
|
568
|
+
z: number;
|
|
569
|
+
};
|
|
570
|
+
maxValue: {
|
|
571
|
+
x: number;
|
|
572
|
+
y: number;
|
|
573
|
+
z: number;
|
|
574
|
+
};
|
|
575
|
+
};
|
|
576
|
+
|
|
577
|
+
declare type RequestAnimationFrameFn = ((callback: FrameRequestCallback) => number) | ((callback: XRFrameRequestCallback) => void);
|
|
578
|
+
|
|
454
579
|
declare interface RuntimeSettings extends EmbindObject {
|
|
455
580
|
maxBandwidthBitsPerSecond: number;
|
|
456
581
|
maxConcurrentRequests: number;
|
|
457
582
|
targetFramesPerSecond: number;
|
|
458
583
|
xrModeActive: boolean;
|
|
584
|
+
splatCountBudget: number;
|
|
585
|
+
splatCountBudgetCap: number;
|
|
459
586
|
}
|
|
460
587
|
|
|
461
588
|
export declare class Scene extends EventTarget {
|
|
@@ -467,6 +594,7 @@ export declare class Scene extends EventTarget {
|
|
|
467
594
|
readonly id: number;
|
|
468
595
|
get key(): unknown;
|
|
469
596
|
set key(key: unknown);
|
|
597
|
+
/* Excluded from this release type: _assetFormat */
|
|
470
598
|
get viewerKey(): string | null;
|
|
471
599
|
set viewerKey(viewerKey: string | null);
|
|
472
600
|
get streams(): Set<Stream>;
|
|
@@ -476,6 +604,18 @@ export declare class Scene extends EventTarget {
|
|
|
476
604
|
readonly client: Client;
|
|
477
605
|
readonly handle?: number;
|
|
478
606
|
constructor({ miris, viewerKey }: SceneInit);
|
|
607
|
+
/**
|
|
608
|
+
* Drives a frame and answers whether *this* scene's canvas needs repainting. Call it once per
|
|
609
|
+
* displayed frame from the host's animation loop, and render when it returns true.
|
|
610
|
+
*
|
|
611
|
+
* Every scene on the page calls this from its own loop. The first call in a displayed frame
|
|
612
|
+
* drives one engine tick for all of them; the rest recognise the frame and reuse it.
|
|
613
|
+
*
|
|
614
|
+
* @param ts the host's frame timestamp. Optional - the document timeline supplies one, and it
|
|
615
|
+
* reads the same for every scene in a displayed frame. Pass it when the host runs its own
|
|
616
|
+
* clock, as an immersive XR session does, because XRFrame time is not the document timeline.
|
|
617
|
+
*/
|
|
618
|
+
update(ts?: DOMHighResTimeStamp): boolean;
|
|
479
619
|
dispose(): void;
|
|
480
620
|
fetchAssets(tags?: string | Iterable<string>): Promise<{
|
|
481
621
|
name: string;
|
|
@@ -483,12 +623,14 @@ export declare class Scene extends EventTarget {
|
|
|
483
623
|
uuid: string;
|
|
484
624
|
tags: string[];
|
|
485
625
|
}[]>;
|
|
486
|
-
getDefaultCameraTransform(): Float32Array<ArrayBuffer> | null | undefined;
|
|
487
626
|
add(stream: Stream): void;
|
|
488
627
|
getStreamForId(streamObjectId: number): Stream | undefined;
|
|
489
628
|
getStreamForDescendentId(descendentObjectId: number): Stream | null;
|
|
490
629
|
getModelRootForDescendentId(descendentObjectId: number): ModelRoot | null;
|
|
630
|
+
_recordAssetFormat(modelRoot: ModelRoot, formatVersion: number): void;
|
|
631
|
+
/* Excluded from this release type: _getFeatureMesh */
|
|
491
632
|
/* Excluded from this release type: _getDrMap */
|
|
633
|
+
/* Excluded from this release type: _onDrMapLadder */
|
|
492
634
|
/* Excluded from this release type: _onFeatureData */
|
|
493
635
|
/* Excluded from this release type: _onSceneLoaded */
|
|
494
636
|
delete(stream: Stream): void;
|
|
@@ -501,6 +643,7 @@ declare interface SceneChangeIds extends EmbindObject {
|
|
|
501
643
|
readonly modifiedObjectsCount: number;
|
|
502
644
|
readonly deactivatedObjectsCount: number;
|
|
503
645
|
readonly deletedObjectsCount: number;
|
|
646
|
+
readonly remaskedObjectsCount: number;
|
|
504
647
|
}
|
|
505
648
|
|
|
506
649
|
export declare type SceneInit = {
|
|
@@ -512,6 +655,13 @@ declare interface SceneMetadata extends EmbindObject {
|
|
|
512
655
|
readonly inputColorSpace: string;
|
|
513
656
|
}
|
|
514
657
|
|
|
658
|
+
declare type SparkAttributeInfo = {
|
|
659
|
+
elementsPerSplat: number;
|
|
660
|
+
discard: boolean;
|
|
661
|
+
};
|
|
662
|
+
|
|
663
|
+
export declare const sparkAttributeList: Record<string, SparkAttributeInfo>;
|
|
664
|
+
|
|
515
665
|
declare interface SpatialFormat extends EmbindObject {
|
|
516
666
|
metersPerUnit: number;
|
|
517
667
|
upAxis: number;
|
|
@@ -539,6 +689,8 @@ export declare class Stream extends EventTarget {
|
|
|
539
689
|
set key(key: unknown);
|
|
540
690
|
get matrix(): Matrix4x4Tuple;
|
|
541
691
|
set matrix(matrix: Matrix4x4Tuple);
|
|
692
|
+
get opacity(): number;
|
|
693
|
+
set opacity(opacity: number);
|
|
542
694
|
get boundingBox(): {
|
|
543
695
|
min: {
|
|
544
696
|
x: number;
|
|
@@ -569,6 +721,8 @@ export declare class Stream extends EventTarget {
|
|
|
569
721
|
constructor(options: StreamInit);
|
|
570
722
|
_initStream({ uuid }: StreamInit): void;
|
|
571
723
|
/* Excluded from this release type: _onStreamLoaded */
|
|
724
|
+
getDefaultCameraTransform(): Float32Array<ArrayBuffer> | null | undefined;
|
|
725
|
+
/* Excluded from this release type: _getViewingVolumeObb */
|
|
572
726
|
/* Excluded from this release type: _onRootLoaded */
|
|
573
727
|
add(modelRoot: ModelRoot): void;
|
|
574
728
|
end(): void;
|