Interface GPUCommandEncoder

The GPUCommandEncoder interface of the WebGPU API represents an encoder that collects a sequence of GPU commands to be issued to the GPU. Available only in secure contexts.

MDN Reference

interface GPUCommandEncoder {
    label: string;
    beginComputePass(
        descriptor?: GPUComputePassDescriptor,
    ): GPUComputePassEncoder;
    beginRenderPass(descriptor: GPURenderPassDescriptor): GPURenderPassEncoder;
    clearBuffer(buffer: GPUBuffer, offset?: number, size?: number): void;
    copyBufferToBuffer(
        source: GPUBuffer,
        destination: GPUBuffer,
        size?: number,
    ): void;
    copyBufferToBuffer(
        source: GPUBuffer,
        sourceOffset: number,
        destination: GPUBuffer,
        destinationOffset: number,
        size?: number,
    ): void;
    copyBufferToTexture(
        source: GPUTexelCopyBufferInfo,
        destination: GPUTexelCopyTextureInfo,
        copySize: GPUExtent3D,
    ): void;
    copyBufferToTexture(
        source: GPUTexelCopyBufferInfo,
        destination: GPUTexelCopyTextureInfo,
        copySize: Iterable<number>,
    ): void;
    copyTextureToBuffer(
        source: GPUTexelCopyTextureInfo,
        destination: GPUTexelCopyBufferInfo,
        copySize: GPUExtent3D,
    ): void;
    copyTextureToBuffer(
        source: GPUTexelCopyTextureInfo,
        destination: GPUTexelCopyBufferInfo,
        copySize: Iterable<number>,
    ): void;
    copyTextureToTexture(
        source: GPUTexelCopyTextureInfo,
        destination: GPUTexelCopyTextureInfo,
        copySize: GPUExtent3D,
    ): void;
    copyTextureToTexture(
        source: GPUTexelCopyTextureInfo,
        destination: GPUTexelCopyTextureInfo,
        copySize: Iterable<number>,
    ): void;
    finish(descriptor?: GPUCommandBufferDescriptor): GPUCommandBuffer;
    insertDebugMarker(markerLabel: string): void;
    popDebugGroup(): void;
    pushDebugGroup(groupLabel: string): void;
    resolveQuerySet(
        querySet: GPUQuerySet,
        firstQuery: number,
        queryCount: number,
        destination: GPUBuffer,
        destinationOffset: number,
    ): void;
}

Hierarchy (View Summary)

GPUDebugCommandsMixin
GPUObjectBase
- GPUCommandEncoder

Index

Properties

label

Methods

beginComputePass beginRenderPass clearBuffer copyBufferToBuffer copyBufferToTexture copyTextureToBuffer copyTextureToTexture finish insertDebugMarker popDebugGroup pushDebugGroup resolveQuerySet

Properties

label

label: string

MDN Reference

Methods

beginComputePass

beginComputePass(descriptor?: GPUComputePassDescriptor): GPUComputePassEncoder
The beginComputePass() method of the GPUCommandEncoder interface starts encoding a compute pass, returning a GPUComputePassEncoder that can be used to control computation.

MDN Reference
Parameters
- Optionaldescriptor: GPUComputePassDescriptor
Returns GPUComputePassEncoder

beginRenderPass

beginRenderPass(descriptor: GPURenderPassDescriptor): GPURenderPassEncoder
The beginRenderPass() method of the GPUCommandEncoder interface starts encoding a render pass, returning a GPURenderPassEncoder that can be used to control rendering.

MDN Reference
Parameters
- descriptor: GPURenderPassDescriptor
Returns GPURenderPassEncoder

clearBuffer

clearBuffer(buffer: GPUBuffer, offset?: number, size?: number): void
The clearBuffer() method of the GPUCommandEncoder interface encodes a command that fills a region of a GPUBuffer with zeroes.

MDN Reference
Parameters
- buffer: GPUBuffer
- Optionaloffset: number
- Optionalsize: number
Returns void

copyBufferToBuffer

copyBufferToBuffer(
    source: GPUBuffer,
    destination: GPUBuffer,
    size?: number,
): void
The copyBufferToBuffer() method of the GPUCommandEncoder interface encodes a command that copies data from one GPUBuffer to another.

MDN Reference
Parameters
- source: GPUBuffer
- destination: GPUBuffer
- Optionalsize: number
Returns void
copyBufferToBuffer(
    source: GPUBuffer,
    sourceOffset: number,
    destination: GPUBuffer,
    destinationOffset: number,
    size?: number,
): void
Parameters
- source: GPUBuffer
- sourceOffset: number
- destination: GPUBuffer
- destinationOffset: number
- Optionalsize: number
Returns void

copyBufferToTexture

copyBufferToTexture(
    source: GPUTexelCopyBufferInfo,
    destination: GPUTexelCopyTextureInfo,
    copySize: GPUExtent3D,
): void
The copyBufferToTexture() method of the GPUCommandEncoder interface encodes a command that copies data from a GPUBuffer to a GPUTexture.

MDN Reference
Parameters
- source: GPUTexelCopyBufferInfo
- destination: GPUTexelCopyTextureInfo
- copySize: GPUExtent3D
Returns void
copyBufferToTexture(
    source: GPUTexelCopyBufferInfo,
    destination: GPUTexelCopyTextureInfo,
    copySize: Iterable<number>,
): void
The copyBufferToTexture() method of the GPUCommandEncoder interface encodes a command that copies data from a GPUBuffer to a GPUTexture.

MDN Reference
Parameters
- source: GPUTexelCopyBufferInfo
- destination: GPUTexelCopyTextureInfo
- copySize: Iterable<number>
Returns void

copyTextureToBuffer

copyTextureToBuffer(
    source: GPUTexelCopyTextureInfo,
    destination: GPUTexelCopyBufferInfo,
    copySize: GPUExtent3D,
): void
The copyTextureToBuffer() method of the GPUCommandEncoder interface encodes a command that copies data from a GPUTexture to a GPUBuffer.

MDN Reference
Parameters
- source: GPUTexelCopyTextureInfo
- destination: GPUTexelCopyBufferInfo
- copySize: GPUExtent3D
Returns void
copyTextureToBuffer(
    source: GPUTexelCopyTextureInfo,
    destination: GPUTexelCopyBufferInfo,
    copySize: Iterable<number>,
): void
The copyTextureToBuffer() method of the GPUCommandEncoder interface encodes a command that copies data from a GPUTexture to a GPUBuffer.

MDN Reference
Parameters
- source: GPUTexelCopyTextureInfo
- destination: GPUTexelCopyBufferInfo
- copySize: Iterable<number>
Returns void

copyTextureToTexture

copyTextureToTexture(
    source: GPUTexelCopyTextureInfo,
    destination: GPUTexelCopyTextureInfo,
    copySize: GPUExtent3D,
): void
The copyTextureToTexture() method of the GPUCommandEncoder interface encodes a command that copies data from one GPUTexture to another.

MDN Reference
Parameters
- source: GPUTexelCopyTextureInfo
- destination: GPUTexelCopyTextureInfo
- copySize: GPUExtent3D
Returns void
copyTextureToTexture(
    source: GPUTexelCopyTextureInfo,
    destination: GPUTexelCopyTextureInfo,
    copySize: Iterable<number>,
): void
The copyTextureToTexture() method of the GPUCommandEncoder interface encodes a command that copies data from one GPUTexture to another.

MDN Reference
Parameters
- source: GPUTexelCopyTextureInfo
- destination: GPUTexelCopyTextureInfo
- copySize: Iterable<number>
Returns void

finish

finish(descriptor?: GPUCommandBufferDescriptor): GPUCommandBuffer
The finish() method of the GPUCommandEncoder interface completes recording of the command sequence encoded on this GPUCommandEncoder, returning a corresponding GPUCommandBuffer.

MDN Reference
Parameters
- Optionaldescriptor: GPUCommandBufferDescriptor
Returns GPUCommandBuffer

insertDebugMarker

insertDebugMarker(markerLabel: string): void
MDN Reference
Parameters
- markerLabel: string
Returns void
Inherited from GPUDebugCommandsMixin.insertDebugMarker

popDebugGroup

popDebugGroup(): void
MDN Reference

Returns void
Inherited from GPUDebugCommandsMixin.popDebugGroup

pushDebugGroup

pushDebugGroup(groupLabel: string): void
MDN Reference
Parameters
- groupLabel: string
Returns void
Inherited from GPUDebugCommandsMixin.pushDebugGroup

resolveQuerySet

resolveQuerySet(
    querySet: GPUQuerySet,
    firstQuery: number,
    queryCount: number,
    destination: GPUBuffer,
    destinationOffset: number,
): void
The resolveQuerySet() method of the GPUCommandEncoder interface encodes a command that resolves a GPUQuerySet, copying the results into a specified GPUBuffer.

MDN Reference
Parameters
- querySet: GPUQuerySet
- firstQuery: number
- queryCount: number
- destination: GPUBuffer
- destinationOffset: number
Returns void

Interface GPUCommandEncoder

Hierarchy (View Summary)

Index

Properties

Methods

Properties

label

Methods

beginComputePass

Parameters

Returns GPUComputePassEncoder

beginRenderPass

Parameters

Returns GPURenderPassEncoder

clearBuffer

Parameters

Returns void

copyBufferToBuffer

Parameters

Returns void

Parameters

Returns void

copyBufferToTexture

Parameters

Returns void

Parameters

Returns void

copyTextureToBuffer

Parameters

Returns void

Parameters

Returns void

copyTextureToTexture

Parameters

Returns void

Parameters

Returns void

finish

Parameters

Returns GPUCommandBuffer

insertDebugMarker

Parameters

Returns void

popDebugGroup

Returns void

pushDebugGroup

Parameters

Returns void

resolveQuerySet

Parameters

Returns void

Settings

On This Page