RenderPipeline
Defined in: render/renderPipeline.ts:66
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RenderPipeline():
RenderPipeline
Returns
Section titled “Returns”RenderPipeline
Accessors
Section titled “Accessors”frameElapsed
Section titled “frameElapsed”Get Signature
Section titled “Get Signature”get frameElapsed():
number
Defined in: render/renderPipeline.ts:68
Returns
Section titled “Returns”number
renderingEnabled
Section titled “renderingEnabled”Get Signature
Section titled “Get Signature”get renderingEnabled():
boolean
Defined in: render/renderPipeline.ts:81
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”addPreFlushCallback()
Section titled “addPreFlushCallback()”addPreFlushCallback(
cb):void
Defined in: render/renderPipeline.ts:105
The optional projection is the current pass; legacy manual hosts may omit it.
Parameters
Section titled “Parameters”(registry, viewProjection?) => void
Returns
Section titled “Returns”void
addScreenOverlayCallback()
Section titled “addScreenOverlayCallback()”addScreenOverlayCallback(
cb):void
Defined in: render/renderPipeline.ts:115
Register geometry a plugin draws into the SCREEN overlay rather than into a camera — the sibling of addPreFlushCallback, separate for the same reason the two collects are: a callback that ran in both would put the same glyph in each list. Runs between the overlay’s collect and its pass.
Parameters
Section titled “Parameters”(registry, viewProjection?) => void
Returns
Section titled “Returns”void
beginFrame()
Section titled “beginFrame()”beginFrame(
elapsedSec?):void
Defined in: render/renderPipeline.ts:130
Parameters
Section titled “Parameters”elapsedSec?
Section titled “elapsedSec?”number = 0
Returns
Section titled “Returns”void
beginScreenCapture()
Section titled “beginScreenCapture()”beginScreenCapture():
void
Defined in: render/renderPipeline.ts:173
Returns
Section titled “Returns”void
endFrame()
Section titled “endFrame()”endFrame():
void
Defined in: render/renderPipeline.ts:145
Closes the frame. The pair of beginFrame, and the last thing a frame does: a backend that borrows the swapchain image for a frame gives it back here, so everything drawn after the first camera — a second camera, the screen post stack, the overlay — still has somewhere to land.
Returns
Section titled “Returns”void
endScreenCapture()
Section titled “endScreenCapture()”endScreenCapture():
void
Defined in: render/renderPipeline.ts:184
Returns
Section titled “Returns”void
render()
Section titled “render()”render(
params):void
Defined in: render/renderPipeline.ts:210
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”void
renderCamera()
Section titled “renderCamera()”renderCamera(
params):void
Defined in: render/renderPipeline.ts:229
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”void
renderScreenOverlay()
Section titled “renderScreenOverlay()”renderScreenOverlay(
registry,overlay,target?):void
Defined in: render/renderPipeline.ts:155
The frame’s screen-space overlay: one pass, after every camera and after post. It takes a projection and a rect and no camera, which is what makes a HUD hold still while the view moves. Silent when the core has no overlay pass, which has not partitioned the domains either.
Parameters
Section titled “Parameters”registry
Section titled “registry”CppRegistry
overlay
Section titled “overlay”target?
Section titled “target?”number = 0
Returns
Section titled “Returns”void
runPreFlushCallbacks()
Section titled “runPreFlushCallbacks()”runPreFlushCallbacks(
registry,viewProjection?):void
Defined in: render/renderPipeline.ts:126
Run what plugins registered to draw just before the frame flushes (glyph quads, today). submitScene calls this in the middle of its own sequence; a host that owns its render loop in C++ — the native one — calls it directly at the same point, between collecting the scene and flushing, so text lands in the same frame either way.
Parameters
Section titled “Parameters”registry
Section titled “registry”CppRegistry
viewProjection?
Section titled “viewProjection?”Float32Array<ArrayBufferLike>
Returns
Section titled “Returns”void
setActiveScenes()
Section titled “setActiveScenes()”setActiveScenes(
scenes):void
Defined in: render/renderPipeline.ts:91
Parameters
Section titled “Parameters”scenes
Section titled “scenes”Set<string> | null
Returns
Section titled “Returns”void
setPostProcess()
Section titled “setPostProcess()”setPostProcess(
pp):void
Defined in: render/renderPipeline.ts:100
Inject this App’s post-process API (by PostProcessPlugin). When null, the pipeline does no post-processing — it has no hard dependency on the post-process subsystem.
Parameters
Section titled “Parameters”PostProcessAPI | null
Returns
Section titled “Returns”void
setQuality()
Section titled “setQuality()”setQuality(
quality,apply?):void
Defined in: render/renderPipeline.ts:86
Parameters
Section titled “Parameters”quality
Section titled “quality”apply?
Section titled “apply?”() => void
Returns
Section titled “Returns”void
setRenderingEnabled()
Section titled “setRenderingEnabled()”setRenderingEnabled(
enabled):void
Defined in: render/renderPipeline.ts:84
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
submitScene()
Section titled “submitScene()”submitScene(
registry,viewProjection,viewport,_elapsed):void
Defined in: render/renderPipeline.ts:192
Parameters
Section titled “Parameters”registry
Section titled “registry”CppRegistry
viewProjection
Section titled “viewProjection”Float32Array
viewport
Section titled “viewport”_elapsed
Section titled “_elapsed”number
Returns
Section titled “Returns”void