Abstract Class: RenderGraphPass
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:316
A single rendering capability in the graph. Subclasses declare their identity via name, allocate GPU resources and declare dependencies in setup, and submit GPU work in execute.
reads, writes, and creates are populated by RenderGraph.compile after setup() runs (setup is deferred from add() to the next compile, so add() call order doesn't constrain resource-dependency order). They start as frozen empty arrays at add() time and are replaced with the recorded b.read / b.write names on commit.
Extends
Extended by
ClearDepthPassClusterLightingPassColorPassDecalShadowVolumePassGBufferResourcePassGIPassGPUCullPassGUIPassHiZPassMotionVectorPassPointShadowPassPostPassPreDepthPassReflectionPassSceneCapturePassSceneColorPyramidPassShadowPassSkyPassSortedTransparentPassTransmissionOpaquePassTransparentDualDepthPeelingPassTransparentDualDepthPeelingResolvePassTransparentOITPassTransparentResolvePass
Constructors
Constructor
new RenderGraphPass():
RenderGraphPass
Returns
RenderGraphPass
Inherited from
Properties
name
abstractreadonlyname:string
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:320
Unique pass identifier. Used as the graph-node key and in error messages — prefer PascalCase ending in Pass (e.g. ShadowPass, ColorPass).
materialPasses
readonlymaterialPasses: readonlyPassType[] =[]
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:324
Material-side pass types consumed. Optional; defaults to none for pure compute / copy passes.
enabled
enabled:
boolean=true
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:332
Runtime kill switch. graph.disablePass(name) flips this. A disabled pass is treated as if it weren't in the graph: it's filtered out before validation + topo sort, and skipped during execute. Disabling a producer whose output is read by another enabled pass makes the next compile() throw UnresolvedResourceError.
layerMask
layerMask:
number=VisibleLayer.All
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:347
Which scene layers this pass consumes, as a bitmask. Default VisibleLayer.All reproduces the legacy "draw every collected node" behaviour. Custom passes (or custom RendererJobs wiring built-in passes) override this to restrict the pass to specific composition layers — combined with the active camera's cullingMask at execute time via bitwise AND, then matched against each node's visibleLayer:
(node.visibleLayer & pass.layerMask & camera.cullingMask) !== 0
Use collectLayered from inside execute() to fetch the filtered opaque/transparent lists; it threads layerMask and the camera mask through EntityCollect.getLayerLists.
reads
readonlyreads: readonlystring[]
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:353
Names this pass reads. Populated on the first RenderGraph.compile() that processes this pass, from the b.read(...) calls inside its setup(). Empty frozen array before compile.
writes
readonlywrites: readonlystring[]
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:358
Names this pass writes (creator + mutator combined). Populated on the first RenderGraph.compile() from the b.write(...) calls inside setup(). Empty frozen array before compile.
creates
readonlycreates: readonlystring[]
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:363
Subset of writes for which this pass was the creator (called b.write(name, factory), not b.write(name)). The validator's single-creator rule operates on this set.
dependencies?
optionaldependencies?:ReadonlySet<string>
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:377
Explicit ordering dependencies on other pass names, set either from setup() via b.dependsOn(name) or by direct assignment before the next compile. Each entry adds a topo-sort edge <name> → this, independent of any resource edge. Use for side-effect dependencies the graph can't see (indirect buffers, off-screen RTs consumed via materials, etc.).
Beyond the edge, an entry here also positions this pass in the compiled schedule: the effective scheduling key collapses to "just after the latest dep", so a late-added pass with explicit dependencies runs next to its dep instead of trailing at the end of the queue. See topoSort for the full rule.
Methods
dispatchEvent()
dispatchEvent(
event):void
Defined in: src/event/CEventDispatcher.ts:24
Dispatch an event to all registered objects with a specific type of listener.
Parameters
event
Returns
void
Inherited from
CEventDispatcher.dispatchEvent
addEventListener()
addEventListener(
type,callback,thisObject,param?,priority?):number
Defined in: src/event/CEventDispatcher.ts:78
register an event listener to event distancher.
Parameters
type
string | number
{string} event type.
callback
Function
{Function} The callback function that handles events. This function must accept an Event3D object as its unique parameter and cannot return any result. for example: function(evt:Event3D):void.
thisObject
any
{any} Current registration object, it'll call callback function.
param?
any = null
{any} the data binded to registered event, the default value is null.
priority?
number = 0
{number} The priority of callback function execution, with a larger set value having priority to call
Returns
number
Returns register event id
Inherited from
CEventDispatcher.addEventListener
removeEventListener()
removeEventListener(
type,callback,thisObject):void
Defined in: src/event/CEventDispatcher.ts:112
Remove Event Listening
Parameters
type
string | number
{string} event type
callback
Function
{Function} callback function of event register
thisObject
any
{any} The current registered object.
Returns
void
Inherited from
CEventDispatcher.removeEventListener
removeEventListenerAt()
removeEventListenerAt(
id):boolean
Defined in: src/event/CEventDispatcher.ts:132
Remove an event Listening with id
Parameters
id
number
Returns
boolean
Inherited from
CEventDispatcher.removeEventListenerAt
removeAllEventListener()
removeAllEventListener(
eventType?):void
Defined in: src/event/CEventDispatcher.ts:152
Specify a event type to remove all related event listeners eventType event type, set null to remove all event listeners
Parameters
eventType?
string | number
Returns
void
Inherited from
CEventDispatcher.removeAllEventListener
containEventListener()
containEventListener(
type):boolean
Defined in: src/event/CEventDispatcher.ts:184
whether the target presence of a listener with event type.
Parameters
type
string
{string} event type.
Returns
boolean
Returns a boolean.
Inherited from
CEventDispatcher.containEventListener
hasEventListener()
hasEventListener(
type,callback?,thisObject?):boolean
Defined in: src/event/CEventDispatcher.ts:197
whether the target presence of a listener with event type. it associate more registration parameters.
Parameters
type
string | number
{string} event name.
callback?
Function = null
{Function} callback function of event register.
thisObject?
any = null
{any} The registered object.
Returns
boolean
Returns a boolean.
Inherited from
CEventDispatcher.hasEventListener
setup()
setup(
_b):void
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:385
Allocate GPU resources, declare graph-level dependencies via b.read / b.write. Called from RenderGraph.compile() — setup is deferred from add() so add() call order doesn't constrain resource-dependency order. Forward references (reads to a resource a later-added pass creates) are resolved through a multi-round retry loop in compile().
Parameters
_b
Returns
void
execute()
abstractexecute(ctx):void
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:392
Execute the pass for one frame. Implementations build command encoders via ctx.view.engine3D.context3D.gpuContext, read inputs via ctx.get('<name>'), and submit GPU work.
Parameters
ctx
Returns
void
destroy()
destroy():
void
Defined in: src/gfx/renderJob/graph/RenderGraphPass.ts:397
Optional teardown hook called from graph.destroy() — release orphan Object3Ds / view quads / device resources that the pass owns directly.
Returns
void