Interface RenderNodeGPUExtension

GPU graph contribution owned by an optional scene-node addon.

interface RenderNodeGPUExtension {
    hasOpaqueRenderers: boolean;
    hasPendingWork: boolean;
    requiresSampledDepth: boolean;
    frameDiscarded(frameIndex: number): void;
    frameSubmitted(frameIndex: number): void;
    isVisible(camera: Camera): boolean;
    record(
        context: RenderPipelineContext,
        color: RenderGraphTextureHandle,
        depth: RenderGraphTextureHandle | null,
        drawVisible: boolean,
        phase: "transparent" | "opaque",
    ): void;
}

Index

Properties

hasOpaqueRenderers hasPendingWork requiresSampledDepth

Methods

frameDiscarded frameSubmitted isVisible record

Properties

`Readonly`hasOpaqueRenderers

hasOpaqueRenderers: boolean

Whether this contribution has an opaque or alpha-masked phase.

`Readonly`hasPendingWork

hasPendingWork: boolean

Whether graph work must run even when the contribution is outside the camera.

`Readonly`requiresSampledDepth

requiresSampledDepth: boolean

Whether simulation or raster needs the current sampled scene depth.

Methods

frameDiscarded

frameDiscarded(frameIndex: number): void
Roll back staged state after recording or submission is discarded.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/RenderNodeExtension.ts:31

frameSubmitted

frameSubmitted(frameIndex: number): void
Commit staged state only after the enclosing frame submission succeeds.
Parameters
- frameIndex: number
Returns void
- Defined in render/pipeline/RenderNodeExtension.ts:29

isVisible

isVisible(camera: Camera): boolean
Test view visibility without issuing render commands.
Parameters
- camera: Camera
Returns boolean
- Defined in render/pipeline/RenderNodeExtension.ts:19

record

record(
    context: RenderPipelineContext,
    color: RenderGraphTextureHandle,
    depth: RenderGraphTextureHandle | null,
    drawVisible: boolean,
    phase: "transparent" | "opaque",
): void
Record one opaque or transparent contribution through the active Render Graph.
Parameters
- context: RenderPipelineContext
- color: RenderGraphTextureHandle
- depth: RenderGraphTextureHandle | null
- drawVisible: boolean
- phase: "transparent" | "opaque"
Returns void
- Defined in render/pipeline/RenderNodeExtension.ts:21