Interface RenderPipeline

Renderer-local runtime created exactly once by a RenderPipelineFactory.

interface RenderPipeline {
    name: string;
    usesRenderGraphTimeline?: boolean;
    destroy(): void;
    frameDiscarded?(frameIndex: number): void;
    frameSubmitted?(frameIndex: number): void;
    record(context: RenderPipelineContext): unknown;
    recordRenderGraphTimeline?(
        snapshot: Readonly<RenderGraphTimelineSnapshot>,
    ): void;
}

Index

Properties

name usesRenderGraphTimeline?

Methods

destroy frameDiscarded? frameSubmitted? record recordRenderGraphTimeline?

Properties

`Readonly`name

name: string

Human-readable runtime name used in diagnostics.

`Optional` `Readonly`usesRenderGraphTimeline

usesRenderGraphTimeline?: boolean

Whether this runtime needs Render Graph timing without external diagnostics.

Methods

destroy

destroy(): void
Release runtime-owned state exactly once during Renderer destruction.

Returns void
- Defined in render/pipeline/RenderPipeline.ts:301

`Optional`frameDiscarded

frameDiscarded?(frameIndex: number): void
Roll back staged CPU-side temporal state after recording or submission failure.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/RenderPipeline.ts:294

`Optional`frameSubmitted

frameSubmitted?(frameIndex: number): void
Commit CPU-side temporal state after the frame has submitted successfully.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/RenderPipeline.ts:292

record

record(context: RenderPipelineContext): unknown
Record one invocation synchronously into the active application Render Graph.
Parameters
- context: RenderPipelineContext
Returns unknown
An ignored synchronous value. Promise-like values are rejected before RHI execution.
- Defined in render/pipeline/RenderPipeline.ts:290

`Optional`recordRenderGraphTimeline

recordRenderGraphTimeline?(
snapshot: Readonly<RenderGraphTimelineSnapshot>,
): void
Consume opt-in Render Graph timing snapshots. GPU-ready snapshots arrive asynchronously after submission completion and may be used by renderer-local adaptive quality controllers.
Parameters
- snapshot: Readonly<RenderGraphTimelineSnapshot>
Returns void
- Defined in render/pipeline/RenderPipeline.ts:299