API reference

Every public class, method, and event in @codexo/exojs. Generated from source.

classRenderNodePass

@codexo/exojs / rendering / stable

Renders a scene subtree (a RenderNode) as one pass - into the active target, or off-screen when `options.target` is set. The most common pass: world, HUD overlay, an off-screen scene capture. `view`/`target`/`clear` are fixed at construction; only `enabled`/`label` are mutable. The off-screen redirect is built once and reused every frame (no per-frame allocation). The node and any caller `target` are NOT owned by this pass - `destroy()` never frees them.

props

methods

events

Import

import { RenderNodePass } from '@codexo/exojs'

Renders a scene subtree (a RenderNode) as one pass - into the active target, or off-screen when `options.target` is set. The most common pass: world, HUD overlay, an off-screen scene capture.

`view`/`target`/`clear` are fixed at construction; only `enabled`/`label` are mutable. The off-screen redirect is built once and reused every frame (no per-frame allocation). The node and any caller `target` are NOT owned by this pass - `destroy()` never frees them.

Constructors1

new(node: RenderNodeSceneNode that can produce visual output. Adds the rendering pipeline features on top of the structural transform/bounds carried by SceneNode: post-process `fi…, options?: RenderNodePassOptionsOptions for RenderNodePass.): RenderNodePass

Methods3

destroy(): void

Release resources this pass allocated internally. No-op by default; idempotent. Never frees injected scene nodes or caller-provided RenderTextures - those are owned by the caller / scene.

execute(context: RenderingContextOwns rendering orchestration: builds, optimizes and plays the internal RenderPlan for a RenderNode subtree, manages render-target/view state for off-screen cap…): void

Run this pass against context. The active render target is the canvas unless a parent redirected it. Called directly, this runs **regardless of enabled** - enabled is evaluated by the containing RenderPipeline, not self-checked here. Subclasses must not begin execute with if (!this.enabled).

resize(_width: number, _height: number): void

React to a surface / target size change. No-op by default; size-dependent passes (effects with scratch targets) override. Called by RenderPipeline.resize, which the caller wires to app.onResize.

Properties2

enabled: boolean

When false, the containing RenderPipeline skips this pass during execute. Default true. Evaluated by the parent - a direct execute call runs the pass regardless.

label: string

Debug label (inspector / logging). Defaults to the constructor name. Display only - not an identity.

Source

src/rendering/RenderNodePass.ts