Documentation / scene / RGBlackboard
Class: RGBlackboard
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:43
Named registry of render graph resource handles for the current frame.
The blackboard decouples resource producers from consumers: passes that create shared resources register the returned handles by name, and later passes look them up to declare read dependencies. This replaces passing textures through mutable DrawContext fields.
A blackboard instance is valid for a single graph build; create a new one (or clear it) every frame together with the graph.
Constructors
Constructor
new RGBlackboard():
RGBlackboard
Returns
RGBlackboard
Methods
set()
set(
name,handle):void
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:51
Register a resource handle under a name, replacing any previous entry.
Parameters
name
string
Resource name, typically one of FrameResources.
handle
The handle to register.
Returns
void
get()
get(
name):RGHandle
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:59
Look up a resource handle by name.
Parameters
name
string
Resource name, typically one of FrameResources.
Returns
The registered handle, or null if not present this frame.
has()
has(
name):boolean
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:67
Check whether a resource is registered.
Parameters
name
string
Resource name.
Returns
boolean
true if a handle is registered under the name.
expect()
expect(
name):RGHandle
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:75
Look up a resource handle that must exist.
Parameters
name
string
Resource name.
Returns
The registered handle.
clear()
clear():
void
Defined in: libs/scene/src/render/rendergraph/blackboard.ts:85
Remove all registered handles.
Returns
void