Documentation
    Preparing search index...

    Interface GpuRenderPassEncoder

    The commands a render pass records.

    interface GpuRenderPassEncoder {
        draw(
            vertexCount: number,
            instanceCount?: number,
            firstVertex?: number,
            firstInstance?: number,
        ): void;
        drawIndexed(
            indexCount: number,
            instanceCount?: number,
            firstIndex?: number,
            baseVertex?: number,
            firstInstance?: number,
        ): void;
        end(): void;
        setBindGroup(
            index: number,
            bindGroup: object,
            dynamicOffsets?: readonly number[],
        ): void;
        setIndexBuffer(
            buffer: GpuBuffer,
            indexFormat: "uint16" | "uint32",
            offset?: number,
        ): void;
        setPipeline(pipeline: object): void;
        setScissorRect(x: number, y: number, width: number, height: number): void;
        setStencilReference(reference: number): void;
        setVertexBuffer(
            slot: number,
            buffer: GpuBuffer | null,
            offset?: number,
        ): void;
        setViewport(
            x: number,
            y: number,
            width: number,
            height: number,
            minDepth: number,
            maxDepth: number,
        ): void;
    }
    Index
    draw drawIndexed end setBindGroup setIndexBuffer setPipeline setScissorRect setStencilReference setVertexBuffer setViewport

    • Non-indexed draw.

      Parameters

      • vertexCount: number
      • OptionalinstanceCount: number
      • OptionalfirstVertex: number
      • OptionalfirstInstance: number

      Returns void

    • Indexed draw.

      Parameters

      • indexCount: number
      • OptionalinstanceCount: number
      • OptionalfirstIndex: number
      • OptionalbaseVertex: number
      • OptionalfirstInstance: number

      Returns void

    • Binds a bind group, optionally at dynamic offsets.

      Parameters

      • index: number
      • bindGroup: object
      • OptionaldynamicOffsets: readonly number[]

      Returns void

    • Binds the index buffer.

      Parameters

      • buffer: GpuBuffer
      • indexFormat: "uint16" | "uint32"
      • Optionaloffset: number

      Returns void

    • Confines writes — including this backend's clear draws — to a rectangle.

      Parameters

      • x: number
      • y: number
      • width: number
      • height: number

      Returns void

    • Sets the stencil reference the pipeline's compare and "replace" op read (§67, WP-R1.3). Pass state, initially 0 — the renderer mirrors it per frame and issues this only when a stencil-carrying draw needs a different value, so a clipless frame records none at all.

      Parameters

      • reference: number

      Returns void

    • Binds a vertex buffer into a slot of the pipeline's vertex layout.

      Parameters

      • slot: number
      • buffer: GpuBuffer | null
      • Optionaloffset: number

      Returns void

    • Sets the draw rectangle, in framebuffer pixels with a top-left origin (see webgpu-renderer.ts for the flip out of §48's bottom-left rectangle).

      Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • minDepth: number
      • maxDepth: number

      Returns void

    Settings
    Member Visibility

    On This Page
    Methods