API reference

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

interfaceSceneTransitionSession

@codexo/exojs / core / stable

One navigation's worth of mutable transition state - created fresh per navigation by SceneTransition.beginSession, driven by the Director until SceneTransitionSession.done, then destroyed. Never reused across navigations.

props

methods

events

Import

import { SceneTransitionSession } from '@codexo/exojs'

Methods3

destroy(): void

Called exactly once, regardless of exit path (normal completion, pre-commit abort, post-commit failure, or the Director being destroyed mid-session). No further update()/render() calls follow.

render(context: RenderingContextOwns rendering orchestration: builds, optimizes and plays the internal RenderPlan for a RenderNode subtree, manages render-target/view state for off-screen cap…, frame: SceneTransitionFramePer-frame render inputs handed to SceneTransitionSession.render. See each field below for the exact non-null conditions it holds under.): void

Draw this transition session's own visual output - not the scene itself; it does not share the render-surface the scene draws to.

update(delta: SecondsA length of time in seconds. The unit every duration in the public API is expressed in - frame deltas, the fixed step, elapsed totals, timer limits. It is a `n…): void

Advance time-based progress. Called once per frame.

Properties2

done: boolean

true once this transition session has fully finished. Must never be true before SceneTransitionEnvironment.committed is also true - see SceneTransitionLifecycleError.

placement: "scene" | "screen"

Which render layer this transition session's output composites against, read live every frame. May change mid-session for composed sessions.

Source

src/core/scene/SceneTransition.ts