Interface ScriptableRenderGraph

Narrow, backend-neutral graph surface exposed during RenderPipeline.record().

interface ScriptableRenderGraph {
    acquirePersistentTarget(
        key: object,
        descriptor: Readonly<RenderPipelinePersistentTargetDescriptor>,
    ): RenderPipelineTargetResources;
    addPass<P extends object>(
        pass: ScriptableRenderPass<P>,
        parameters: P,
    ): RenderGraphPassHandle;
    createBuffer(
        name: string,
        descriptor: Readonly<RenderPipelineBufferDescriptor>,
    ): RenderGraphBufferHandle;
    createTexture(
        name: string,
        descriptor: Readonly<RenderPipelineTextureDescriptor>,
    ): RenderGraphTextureHandle;
    importOutput(): RenderPipelineTargetResources;
    importRenderTarget(target: RenderTarget): RenderPipelineTargetResources;
    importStorageBuffer(buffer: StorageBuffer): RenderGraphBufferHandle;
    releasePersistentTarget(key: object): boolean;
}

Index

Methods

acquirePersistentTarget addPass createBuffer createTexture importOutput importRenderTarget importStorageBuffer releasePersistentTarget

Methods

acquirePersistentTarget

acquirePersistentTarget(
key: object,
descriptor: Readonly<RenderPipelinePersistentTargetDescriptor>,
): RenderPipelineTargetResources
Acquire a renderer-local persistent target keyed by runtime-owned object identity.
Parameters
- key: object
- descriptor: Readonly<RenderPipelinePersistentTargetDescriptor>
Returns RenderPipelineTargetResources
- Defined in render/pipeline/ScriptableRenderGraph.ts:245

addPass

addPass<P extends object>(
pass: ScriptableRenderPass<P>,
parameters: P,
): RenderGraphPassHandle
Add one stable pass with frame-retained parameters.
Type Parameters
- P extends object
Parameters
- pass: ScriptableRenderPass<P>
- parameters: P
Returns RenderGraphPassHandle
- Defined in render/pipeline/ScriptableRenderGraph.ts:260

createBuffer

createBuffer(
name: string,
descriptor: Readonly<RenderPipelineBufferDescriptor>,
): RenderGraphBufferHandle
Create a logical transient buffer whose usage is inferred from live passes.
Parameters
- name: string
- descriptor: Readonly<RenderPipelineBufferDescriptor>
Returns RenderGraphBufferHandle
- Defined in render/pipeline/ScriptableRenderGraph.ts:234

createTexture

createTexture(
name: string,
descriptor: Readonly<RenderPipelineTextureDescriptor>,
): RenderGraphTextureHandle
Create a logical transient texture whose usage is inferred from live passes.
Parameters
- name: string
- descriptor: Readonly<RenderPipelineTextureDescriptor>
Returns RenderGraphTextureHandle
- Defined in render/pipeline/ScriptableRenderGraph.ts:229

importOutput

importOutput(): RenderPipelineTargetResources
Import the current surface or selected RenderTarget output.

Returns RenderPipelineTargetResources
- Defined in render/pipeline/ScriptableRenderGraph.ts:241

importRenderTarget

importRenderTarget(target: RenderTarget): RenderPipelineTargetResources
Import a RenderTarget owned by the current Renderer.
Parameters
- target: RenderTarget
Returns RenderPipelineTargetResources
- Defined in render/pipeline/ScriptableRenderGraph.ts:243

importStorageBuffer

importStorageBuffer(buffer: StorageBuffer): RenderGraphBufferHandle
Import one renderer-owned persistent StorageBuffer into the active graph.
Parameters
- buffer: StorageBuffer
Returns RenderGraphBufferHandle
- Defined in render/pipeline/ScriptableRenderGraph.ts:239

releasePersistentTarget

releasePersistentTarget(key: object): boolean
Release one persistent target by runtime-owned key.

Release is committed only after the active frame submits successfully and is rolled back on recording, compilation, preparation, or execution failure. The target cannot be released after it has been acquired by the active frame.
Parameters
- key: object
Returns boolean
Whether a target was associated with the key.
- Defined in render/pipeline/ScriptableRenderGraph.ts:258