voxolithSceneCacheControls
Developer controls for the cache that serveScene({ cache }) fills, from openSceneCacheControls: the model cache's controls (ModelCacheControls), by kind rather than by generator. They read only the small per-entry records. Nothing here runs by itself: the app decides when to inspect, clear or trim.
Defined in: engine/src/worker/scene-cache.ts:64
Methods
clear()
clear(filter?: SceneCacheFilter): Promise<number>;Defined in: engine/src/worker/scene-cache.ts:70
Delete the entries matching filter (all of them without one). Resolves to how many went.
Parameters
| Parameter | Type |
|---|---|
filter? | SceneCacheFilter |
Returns
Promise<number>
close()
close(): void;Defined in: engine/src/worker/scene-cache.ts:74
Close the database connection. The controls are unusable afterwards.
Returns
void
entries()
entries(filter?: SceneCacheFilter): Promise<SceneCacheEntry[]>;Defined in: engine/src/worker/scene-cache.ts:66
Every entry matching filter, most recently used first.
Parameters
| Parameter | Type |
|---|---|
filter? | SceneCacheFilter |
Returns
Promise<SceneCacheEntry[]>
trim()
trim(maxBytes: number): Promise<number>;Defined in: engine/src/worker/scene-cache.ts:72
Evict least recently used entries until the cache is at most maxBytes. Resolves to how many went.
Parameters
| Parameter | Type |
|---|---|
maxBytes | number |
Returns
Promise<number>
usage()
usage(filter?: SceneCacheFilter): Promise<{
bytes: number;
entries: number;
}>;Defined in: engine/src/worker/scene-cache.ts:68
How many entries match filter and their approximate total bytes.
Parameters
| Parameter | Type |
|---|---|
filter? | SceneCacheFilter |
Returns
Promise<{
bytes: number;
entries: number;
}>
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.
SceneCacheEntry
One entry of the scene cache, as SceneCacheControls.entries lists it.