copper3d / Modules / Renderer/sceneBudget / SceneBudget

Interface: SceneBudget ​

Renderer/sceneBudget.SceneBudget

Table of contents ​

Properties ​

• bytes
• overflow
• pin
• register
• release
• rename
• touch
• unpin

Properties ​

bytes ​

• bytes: () => number

Type declaration ​

▸ (): number

Returns ​

number

Defined in ​

src/Renderer/sceneBudget.ts:41

overflow ​

• overflow: () => string[]

Type declaration ​

▸ (): string[]

Keys to evict, least-recently-used first, never pinned. Empty when the total is within budget or nothing evictable is left.

Returns ​

string[]

Defined in ​

src/Renderer/sceneBudget.ts:40

pin ​

• pin: (key: string) => void

Type declaration ​

▸ (key): void

Protects a scene from eviction while it is on screen.

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:31

register ​

• register: (key: string, bytes: number) => void

Type declaration ​

▸ (key, bytes): void

Records (or re-records) a resident scene's decoded size and marks it most-recently-used.

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:27

release ​

• release: (key: string) => void

Type declaration ​

▸ (key): void

Forgets a scene entirely. Call after its GPU resources are freed.

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:34

rename ​

• rename: (from: string, to: string) => void

Type declaration ​

▸ (from, to): void

Carries bytes, queue position and pin state to a new key, for callers that rename a scene in place.

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:37

touch ​

• touch: (key: string) => void

Type declaration ​

▸ (key): void

Marks an already-registered scene most-recently-used. No-op if absent.

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:29

unpin ​

• unpin: (key: string) => void

Type declaration ​

▸ (key): void

Parameters ​

Returns ​

void

Defined in ​

src/Renderer/sceneBudget.ts:32