Documentation / scene / RGBlackboard

Class: RGBlackboard

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:62

Per-frame registry of named render graph resources.

Constructors

Constructor

new RGBlackboard(): RGBlackboard

Returns

RGBlackboard

Methods

set()

set<THandle>(name, handle): void

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:66

Register or replace a resource handle.

Type Parameters

THandle

THandle extends RGHandle<RGHandleKind, unknown>

Parameters

name

FrameResourceKey<THandle>

handle

THandle

Returns

void

---

get()

get<THandle>(name): THandle

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:70

Return a resource handle, or null when absent.

Type Parameters

THandle

THandle extends RGHandle<RGHandleKind, unknown> = RGHandle<RGHandleKind, unknown>

Parameters

name

FrameResourceKey<THandle>

Returns

THandle

---

has()

has(name): boolean

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:74

Check whether a resource is registered.

Parameters

name

FrameResourceKey

Returns

boolean

---

expect()

expect<THandle>(name): THandle

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:78

Return a required resource handle.

Type Parameters

THandle

THandle extends RGHandle<RGHandleKind, unknown> = RGHandle<RGHandleKind, unknown>

Parameters

name

FrameResourceKey<THandle>

Returns

THandle

---

clear()

clear(): void

Defined in: libs/scene/src/render/rendergraph/blackboard.ts:86

Remove all registered handles.

Returns

void