Interface ForwardRenderPipelineFeatureRuntime

Renderer-local feature state created by a reusable feature configuration.

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;
    requiresSampledDepth?(context: RenderPipelineContext): boolean;
    requiresSplitScene?(context: RenderPipelineContext): boolean;
}

Index

Properties

usesRenderGraphTimeline?

Methods

destroy frameDiscarded? frameSubmitted? getSceneScale? record recordRenderGraphTimeline? requiresSampledDepth? requiresSplitScene?

Properties

`Optional` `Readonly`usesRenderGraphTimeline

usesRenderGraphTimeline?: boolean

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

Methods

destroy

destroy(): void
Release renderer-local feature state exactly once.

Returns void
- Defined in render/pipeline/ForwardRenderPipeline.ts:109

`Optional`frameDiscarded

frameDiscarded?(frameIndex: number): void
Roll back feature-owned temporal CPU state when recording or submission is discarded.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/ForwardRenderPipeline.ts:98

`Optional`frameSubmitted

frameSubmitted?(frameIndex: number): void
Commit feature-owned temporal CPU state after a valid frame submission.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/ForwardRenderPipeline.ts:96

`Optional`getSceneScale

getSceneScale?(): number
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
- Defined in render/pipeline/ForwardRenderPipeline.ts:103

record

record(context: ForwardRenderFeatureContext): unknown
Record this feature at its configured injection point.
Parameters
- context: ForwardRenderFeatureContext
Returns unknown
An ignored synchronous value. Promise-like values are rejected before RHI execution.
- Defined in render/pipeline/ForwardRenderPipeline.ts:94

`Optional`recordRenderGraphTimeline

recordRenderGraphTimeline?(
snapshot: Readonly<RenderGraphTimelineSnapshot>,
): void
Consume asynchronous Render Graph CPU/GPU timing snapshots when adaptive work is enabled.
Parameters
- snapshot: Readonly<RenderGraphTimelineSnapshot>
Returns void
- Defined in render/pipeline/ForwardRenderPipeline.ts:105

`Optional`requiresSampledDepth

requiresSampledDepth?(context: RenderPipelineContext): boolean
Request sampled scene depth for this frame before Forward allocates its attachments.
Parameters
- context: RenderPipelineContext
Returns boolean
- Defined in render/pipeline/ForwardRenderPipeline.ts:83

`Optional`requiresSplitScene

requiresSplitScene?(context: RenderPipelineContext): boolean
Request separate opaque and transparent scene passes for this frame. A conditional boundary feature is not recorded when every split request is inactive.
Parameters
- context: RenderPipelineContext
Returns boolean
- Defined in render/pipeline/ForwardRenderPipeline.ts:88