Interface GPUComputePassEncoder

    interface GPUComputePassEncoder {
        __brand: "GPUComputePassEncoder";
        label: string;
        dispatchWorkgroups(
            workgroupCountX: number,
            workgroupCountY?: number,
            workgroupCountZ?: number,
        ): undefined;
        dispatchWorkgroupsIndirect(
            indirectBuffer: GPUBuffer,
            indirectOffset: number,
        ): undefined;
        end(): undefined;
        insertDebugMarker(markerLabel: string): undefined;
        popDebugGroup(): undefined;
        pushDebugGroup(groupLabel: string): undefined;
        setBindGroup(
            index: number,
            bindGroup: GPUBindGroup,
            dynamicOffsets?: Iterable<number>,
        ): undefined;
        setBindGroup(
            index: number,
            bindGroup: GPUBindGroup,
            dynamicOffsetsData: Uint32Array,
            dynamicOffsetsDataStart: number,
            dynamicOffsetsDataLength: number,
        ): undefined;
        setPipeline(pipeline: GPUComputePipeline): undefined;
    }
    Hierarchy

    Properties

    __brand label

    Methods

    dispatchWorkgroups dispatchWorkgroupsIndirect end insertDebugMarker popDebugGroup pushDebugGroup setBindGroup setPipeline

    Properties

    Readonly Internal__brand

    __brand: "GPUComputePassEncoder"

    Nominal type branding. https://github.com/microsoft/TypeScript/pull/33038

    label

    label: string

    Methods

    dispatchWorkgroups

    • dispatchWorkgroups(
          workgroupCountX: number,
          workgroupCountY?: number,
          workgroupCountZ?: number,
      ): undefined

    • Dispatch work to be performed with the current GPUComputePipeline. See [[#computing-operations]] for the detailed specification.

      Parameters

      • workgroupCountX: number

        X dimension of the grid of workgroups to dispatch.

      • OptionalworkgroupCountY: number

        Y dimension of the grid of workgroups to dispatch.

      • OptionalworkgroupCountZ: number

        Z dimension of the grid of workgroups to dispatch.

      Returns undefined

    dispatchWorkgroupsIndirect

    • dispatchWorkgroupsIndirect(
          indirectBuffer: GPUBuffer,
          indirectOffset: number,
      ): undefined

    • Dispatch work to be performed with the current GPUComputePipeline using parameters read from a GPUBuffer. See [[#computing-operations]] for the detailed specification. packed block of three 32-bit unsigned integer values (12 bytes total), given in the same order as the arguments for GPUComputePassEncoder#dispatchWorkgroups. For example:

      Parameters

      • indirectBuffer: GPUBuffer

        Buffer containing the indirect dispatch parameters.

      • indirectOffset: number

        Offset in bytes into indirectBuffer where the dispatch data begins.

      Returns undefined

    end

    • end(): undefined

    • Completes recording of the compute pass commands sequence.

      Returns undefined

    insertDebugMarker

    • insertDebugMarker(markerLabel: string): undefined

    • Marks a point in a stream of commands with a label.

      Parameters

      • markerLabel: string

        The label to insert.

      Returns undefined

    popDebugGroup

    pushDebugGroup

    • pushDebugGroup(groupLabel: string): undefined

    • Begins a labeled debug group containing subsequent commands.

      Parameters

      • groupLabel: string

        The label for the command group.

      Returns undefined

    setBindGroup

    • setBindGroup(
          index: number,
          bindGroup: GPUBindGroup,
          dynamicOffsets?: Iterable<number>,
      ): undefined

    • Sets the current GPUBindGroup for the given index.

      Parameters

      • index: number

        The index to set the bind group at.

      • bindGroup: GPUBindGroup

        Bind group to use for subsequent render or compute commands. <!--The overload appears to be confusing bikeshed, and it ends up expecting this to define the arguments for the 5-arg variant of the method, despite the "for" explicitly pointing at the 3-arg variant. See

      • OptionaldynamicOffsets: Iterable<number>

        Array containing buffer offsets in bytes for each entry in bindGroup marked as GPUBindGroupLayoutEntry#buffer.GPUBufferBindingLayout#hasDynamicOffset.-->

      Returns undefined

    • setBindGroup(
          index: number,
          bindGroup: GPUBindGroup,
          dynamicOffsetsData: Uint32Array,
          dynamicOffsetsDataStart: number,
          dynamicOffsetsDataLength: number,
      ): undefined

    • Sets the current GPUBindGroup for the given index, specifying dynamic offsets as a subset of a Uint32Array.

      Parameters

      • index: number

        The index to set the bind group at.

      • bindGroup: GPUBindGroup

        Bind group to use for subsequent render or compute commands.

      • dynamicOffsetsData: Uint32Array

        Array containing buffer offsets in bytes for each entry in bindGroup marked as GPUBindGroupLayoutEntry#buffer.GPUBufferBindingLayout#hasDynamicOffset.

      • dynamicOffsetsDataStart: number

        Offset in elements into dynamicOffsetsData where the buffer offset data begins.

      • dynamicOffsetsDataLength: number

        Number of buffer offsets to read from dynamicOffsetsData.

      Returns undefined

    setPipeline

    Settings

    Member Visibility

    On This Page

    Properties
    Methods