Hilo3d API - v2.0.0-alpha.9
    Preparing search index...

    Interface ForwardRenderPipelineFeatureRuntime

    Renderer-local feature state created by a reusable feature configuration. Optional requirement, scale and notification callbacks are captured during runtime creation. Callbacks are synchronous except for the optional timeline observer.

    interface ForwardRenderPipelineFeatureRuntime {
        usesRenderGraphTimeline?: boolean;
        destroy(): void;
        frameDiscarded?(frameIndex: number): void;
        frameSubmitted?(frameIndex: number): void;
        getSceneScale?(): number;
        record(context: ForwardRenderFeatureContext): unknown;
        recordRenderGraphTimeline?(
            snapshot: Readonly<RenderGraphTimelineSnapshot>,
        ): void | Promise<void>;
        requiresSampledDepth?(context: RenderPipelineContext): boolean;
        requiresSplitScene?(context: RenderPipelineContext): boolean;
    }
    Index
    usesRenderGraphTimeline?: boolean

    Enable internal Render Graph timing when this feature actively consumes it.

    • Roll back synchronously. Every feature is notified even if another rollback throws.

      Parameters

      • frameIndex: number

      Returns void

    • Commit temporal CPU state synchronously. Every feature is notified even if another throws.

      Parameters

      • frameIndex: number

      Returns void

    • Return this frame's scene scale. The value must stay between the feature's declared sceneScale floor and one. Omit for fixed-resolution features.

      Returns number