Documentation / scene / RGPassBuilder
Interface: RGPassBuilder<TData>
Defined in: libs/scene/src/render/rendergraph/types.ts:198
Declares a pass's resource access and execution callback.
Type Parameters
TData
TData = any
Methods
read()
read(
handle):void
Defined in: libs/scene/src/render/rendergraph/types.ts:200
Declare a read of an existing resource.
Parameters
handle
Returns
void
write()
Call Signature
write<
TTexture>(handle,options?):RGTextureHandle<TTexture>
Defined in: libs/scene/src/render/rendergraph/types.ts:206
Write a new resource version. Use the returned handle for later reads and graph outputs. discard permits old-content producers to be culled.
Type Parameters
TTexture
TTexture
Parameters
handle
RGTextureHandle<TTexture>
options?
Returns
RGTextureHandle<TTexture>
Call Signature
write(
handle,options?):RGTextureHandle
Defined in: libs/scene/src/render/rendergraph/types.ts:209
Generic-container fallback; runtime validation still applies.
Parameters
handle
options?
Returns
createTexture()
createTexture<
TTexture>(desc):RGTextureHandle<TTexture>
Defined in: libs/scene/src/render/rendergraph/types.ts:212
Create a transient texture produced by this pass.
Type Parameters
TTexture
TTexture = BaseTexture<unknown>
Parameters
desc
Returns
RGTextureHandle<TTexture>
createToken()
createToken(
name?):RGTokenHandle
Defined in: libs/scene/src/render/rendergraph/types.ts:215
Create a logical token for ordering passes without resource dependencies.
Parameters
name?
string
Returns
createFramebuffer()
createFramebuffer(
desc):RGFramebufferHandle
Defined in: libs/scene/src/render/rendergraph/types.ts:218
Create a graph-managed framebuffer and infer attachment dependencies.
Parameters
desc
Returns
sideEffect()
sideEffect():
void
Defined in: libs/scene/src/render/rendergraph/types.ts:221
Prevent this pass from being culled.
Returns
void
addSubpass()
addSubpass<
D>(name,fn):void
Defined in: libs/scene/src/render/rendergraph/types.ts:224
Add an ordered subpass. Cannot be combined with setExecute.
Type Parameters
D
D = TData
Parameters
name
string
fn
RGExecuteFn<D>
Returns
void
setExecute()
setExecute<
D>(fn):void
Defined in: libs/scene/src/render/rendergraph/types.ts:227
Set the pass callback. Cannot be combined with addSubpass.
Type Parameters
D
D = TData
Parameters
fn
RGExecuteFn<D>
Returns
void