voxolith

SceneCache

The scene worker's cache of encodings and bakes, from openSceneCache or makeSceneCache. Storage errors are swallowed: a failed get is a miss, a failed put keeps nothing. Every put copies what it stores before its first await, so the caller may transfer the result's buffers straight after calling.

Defined in: engine/src/worker/scene-cache.ts:109

Methods

getBake()

getBake(digest: string): Promise<PlacementBake | undefined>;

Defined in: engine/src/worker/scene-cache.ts:125

The bake stored under a bake digest, as fresh arrays; or undefined. It is stored normalised (normalizePlacement): bind it to the current input (bindPlacement) before applying it.

Parameters

ParameterType
digeststring

Returns

Promise<PlacementBake | undefined>


getEncoded()

getEncoded(digest: string): Promise<
  | {
  encoded: EncodedModel;
  placement: string;
}
| undefined>;

Defined in: engine/src/worker/scene-cache.ts:114

The encoding stored under an identity digest, as fresh arrays that each own their buffer, with its placement digest; or undefined. A hit marks the entry used.

Parameters

ParameterType
digeststring

Returns

Promise< | { encoded: EncodedModel; placement: string; } | undefined>


putBake()

putBake(digest: string, bake: PlacementBake): Promise<void>;

Defined in: engine/src/worker/scene-cache.ts:127

Store a bake under a bake digest. Resolves once the write has committed or failed.

Parameters

ParameterType
digeststring
bakePlacementBake

Returns

Promise<void>


putEncoded()

putEncoded(digest: string, encoded: EncodedModel): object;

Defined in: engine/src/worker/scene-cache.ts:120

Store an encoding under an identity digest. Returns its placement digest (a hash of what the placement bake reads of it, computed at once) and a promise that settles once the write has committed or failed.

Parameters

ParameterType
digeststring
encodedEncodedModel

Returns

object

placement
placement: string;
written
written: Promise<void>;

On this page