Interface GPURenderBundleEncoder

The GPURenderBundleEncoder interface of the WebGPU API is used to pre-record bundles of commands. Available only in secure contexts.

MDN Reference

interface GPURenderBundleEncoder {
    label: string;
    draw(
        vertexCount: number,
        instanceCount?: number,
        firstVertex?: number,
        firstInstance?: number,
    ): void;
    drawIndexed(
        indexCount: number,
        instanceCount?: number,
        firstIndex?: number,
        baseVertex?: number,
        firstInstance?: number,
    ): void;
    drawIndexedIndirect(
        indirectBuffer: GPUBuffer,
        indirectOffset: number,
    ): void;
    drawIndirect(indirectBuffer: GPUBuffer, indirectOffset: number): void;
    finish(descriptor?: GPURenderBundleDescriptor): GPURenderBundle;
    insertDebugMarker(markerLabel: string): void;
    popDebugGroup(): void;
    pushDebugGroup(groupLabel: string): void;
    setBindGroup(
        index: number,
        bindGroup: GPUBindGroup | null,
        dynamicOffsets?: number[],
    ): void;
    setBindGroup(
        index: number,
        bindGroup: GPUBindGroup | null,
        dynamicOffsetsData: Uint32Array<ArrayBufferLike>,
        dynamicOffsetsDataStart: number,
        dynamicOffsetsDataLength: number,
    ): void;
    setBindGroup(
        index: number,
        bindGroup: GPUBindGroup | null,
        dynamicOffsets?: Iterable<number, any, any>,
    ): void;
    setIndexBuffer(
        buffer: GPUBuffer,
        indexFormat: GPUIndexFormat,
        offset?: number,
        size?: number,
    ): void;
    setPipeline(pipeline: GPURenderPipeline): void;
    setVertexBuffer(
        slot: number,
        buffer: GPUBuffer | null,
        offset?: number,
        size?: number,
    ): void;
}

Hierarchy (View Summary)

Index
label
draw drawIndexed drawIndexedIndirect drawIndirect finish insertDebugMarker popDebugGroup pushDebugGroup setBindGroup setIndexBuffer setPipeline setVertexBuffer
label: string

MDN Reference

  • MDN Reference

    Parameters

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

    Returns void

  • MDN Reference

    Parameters

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

    Returns void

Was this helpful?