API reference
Every public class, method, and event in @codexo/exojs. Generated from source.
classPhasedSceneTransition
Single-class `enter()`/`exit()` authoring layer over the full SceneTransition contract - covers the common case (fade, slide, wipe, a custom flash) with no need to hand-manage timing, easing, or session lifecycle. Subclasses implement PhasedSceneTransition.getPhaseRequirements and override PhasedSceneTransition.enter/PhasedSceneTransition.exit - `createSession()` is implemented once, here, and never needs overriding for this common case.
import { PhasedSceneTransition } from '@codexo/exojs'Single-class `enter()`/`exit()` authoring layer over the full SceneTransition contract - covers the common case (fade, slide, wipe, a custom flash) with no need to hand-manage timing, easing, or session lifecycle. Subclasses implement PhasedSceneTransition.getPhaseRequirements and override PhasedSceneTransition.enter/PhasedSceneTransition.exit - `createSession()` is implemented once, here, and never needs overriding for this common case.
new(options: PhasedSceneTransitionOptionsConstruction options for PhasedSceneTransition and its subclasses.): PhasedSceneTransition<PhaseState>beginSession(environment: SceneTransitionEnvironmentHanded to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object w…): SceneTransitionSessionOne navigation's worth of mutable transition state - created fresh per navigation by SceneTransition.beginSession, driven by the Director until SceneTransition…createPhaseState(): PhaseStatecreateSession(environment: SceneTransitionEnvironmentHanded to SceneTransition.beginSession. `commitRequested`/`committed` are live views - they reflect state at read time, not a snapshot taken when this object w…): SceneTransitionSessionOne navigation's worth of mutable transition state - created fresh per navigation by SceneTransition.beginSession, driven by the Director until SceneTransition…destroyPhaseState(_state: PhaseState): voidenter(_context: SceneTransitionPhaseContextPer-frame context handed to PhasedSceneTransition.enter/ PhasedSceneTransition.exit., _state: PhaseState): voidexit(_context: SceneTransitionPhaseContextPer-frame context handed to PhasedSceneTransition.enter/ PhasedSceneTransition.exit., _state: PhaseState): voidgetPhaseRequirements(phase: "enter" | "exit", context: SceneTransitionContextImmutable, read-only description of the navigation a SceneTransition is being asked to run for - passed to SceneTransition.getRequirements and into the SceneTr…): SceneTransitionPhaseRequirementsPer-phase render-resource requirements for one phase (`enter` or `exit`) of a PhasedSceneTransition. Same shape as SceneTransitionRequirements - kept as a dist…getRequirements(context: SceneTransitionContextImmutable, read-only description of the navigation a SceneTransition is being asked to run for - passed to SceneTransition.getRequirements and into the SceneTr…): SceneTransitionRequirementsRender resources a SceneTransitionSession needs, declared once up front via SceneTransition.getRequirements so the Director can provision them before the sessi…getRequirementsForPhase(phase: "enter" | "exit", context: SceneTransitionContextImmutable, read-only description of the navigation a SceneTransition is being asked to run for - passed to SceneTransition.getRequirements and into the SceneTr…): SceneTransitionPhaseRequirementsPer-phase render-resource requirements for one phase (`enter` or `exit`) of a PhasedSceneTransition. Same shape as SceneTransitionRequirements - kept as a dist…runPhase(phase: "enter" | "exit", context: SceneTransitionPhaseContextPer-frame context handed to PhasedSceneTransition.enter/ PhasedSceneTransition.exit., state: PhaseState): voideasing: EasingFunctionplacement: "scene" | "screen"