Interface ScriptableRenderCommands

Execute-only backend-neutral command facade.

interface ScriptableRenderCommands {
    clearBuffer(
        buffer: RenderGraphBufferHandle,
        byteOffset?: number,
        byteLength?: number,
    ): void;
    copyBuffer(
        source: RenderGraphBufferHandle,
        destination: RenderGraphBufferHandle,
    ): void;
    copyTexture(
        source: RenderGraphTextureHandle,
        destination: RenderGraphTextureHandle,
    ): void;
    drawRendererList(list: RendererListHandle): void;
    setScissor(rect: RendererViewport): void;
    setStencilReference(reference: number): void;
    setViewport(viewport: RendererViewport): void;
}

Index

Methods

clearBuffer copyBuffer copyTexture drawRendererList setScissor setStencilReference setViewport

Methods

clearBuffer

clearBuffer(
    buffer: RenderGraphBufferHandle,
    byteOffset?: number,
    byteLength?: number,
): void
Clear the exact destination byte range declared during setup.
Parameters
- buffer: RenderGraphBufferHandle
- OptionalbyteOffset: number
- OptionalbyteLength: number
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:187

copyBuffer

copyBuffer(
source: RenderGraphBufferHandle,
destination: RenderGraphBufferHandle,
): void
Copy one complete buffer using a source/destination pair declared during setup.
Parameters
- source: RenderGraphBufferHandle
- destination: RenderGraphBufferHandle
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:185

copyTexture

copyTexture(
source: RenderGraphTextureHandle,
destination: RenderGraphTextureHandle,
): void
Copy the complete single-sample source texture into the destination.
Parameters
- source: RenderGraphTextureHandle
- destination: RenderGraphTextureHandle
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:183

drawRendererList

drawRendererList(list: RendererListHandle): void
Draw a renderer list declared during setup.
Parameters
- list: RendererListHandle
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:181

setScissor

setScissor(rect: RendererViewport): void
Set the raster scissor in physical attachment pixels.
Parameters
- rect: RendererViewport
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:177

setStencilReference

setStencilReference(reference: number): void
Set the unsigned stencil reference.
Parameters
- reference: number
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:179

setViewport

setViewport(viewport: RendererViewport): void
Set the raster viewport in physical attachment pixels.
Parameters
- viewport: RendererViewport
Returns void
- Defined in render/pipeline/ScriptableRenderGraph.ts:175