Hilo3d API - v2.0.0-alpha.8
    Preparing search index...

    Interface RenderPipelineContext

    Frame-scoped recording context; retaining it after record() returns is an error.

    interface RenderPipelineContext {
        camera: Camera;
        capabilities: RenderPipelineCapabilities;
        clearColor: Readonly<RenderTargetColor>;
        frameIndex: number;
        graph: ScriptableRenderGraph;
        output: RenderPipelineOutput;
        scene: RendererScene;
        useLogDepth: boolean;
        viewport: RendererViewport;
        acquirePassParameters<P extends object>(
            pool: RenderPassParameterPool<P>,
        ): P;
        createOrderedRendererList(
            descriptor: Readonly<OrderedRendererListDescriptor>,
        ): RendererListHandle;
        createRendererList(
            descriptor: Readonly<RendererListDescriptor>,
        ): RendererListHandle;
        cull(options?: Readonly<CullingOptions>): CullingResultsHandle;
        prepareScene(): void;
        recordShadows(
            cullingResults: CullingResultsHandle,
            options?: Readonly<RenderPipelineShadowOptions>,
        ): Readonly<RenderPipelineShadowResources> | null;
        recordView(
            camera: Camera,
            target: RenderTarget,
            record: (context: RenderPipelineContext) => unknown,
        ): void;
        writeStorageBuffer(
            buffer: StorageBuffer,
            byteOffset: number,
            data: ArrayBufferView,
        ): void;
    }
    Index
    camera capabilities clearColor frameIndex graph output scene useLogDepth viewport
    acquirePassParameters createOrderedRendererList createRendererList cull prepareScene recordShadows recordView writeStorageBuffer
    camera: Camera

    Camera supplied to the current renderer invocation.

    capabilities: RenderPipelineCapabilities

    Effective capabilities for the current device generation.

    clearColor: Readonly<RenderTargetColor>

    Renderer clear color snapshotted for this synchronous invocation.

    frameIndex: number

    Monotonic application frame index.

    graph: ScriptableRenderGraph

    Backend-neutral graph facade for this invocation.

    output: RenderPipelineOutput

    Physical output metadata.

    scene: RendererScene

    Scene supplied to the current renderer invocation.

    useLogDepth: boolean

    Whether scene depth uses the renderer's logarithmic depth encoding.

    viewport: RendererViewport

    Active viewport in physical pixels.

    • Record an auxiliary camera into a renderer-owned target in the same graph/submission. Call before this context's first cull or shadow recording. The callback is synchronous, receives its own camera/light/graph-handle scope, and cannot nest recordView(). The parent context is suspended during the callback. Failure aborts the complete application frame. This does not invoke the configured main-view pipeline or advance its temporal history.

      Parameters

      Returns void

    • Stage a dirty upload to a pipeline-owned storage buffer before importing it into this graph. Failed frames retain the dirty CPU shadow for a later valid submission.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods