Interface GPUCommandEncoder

Readonly Internal __brand

beginComputePass

• beginComputePass(descriptor?): GPUComputePassEncoder

• Begins encoding a compute pass described by descriptor. descriptor:

  Parameters

  • Optional descriptor: GPUComputePassDescriptor

  Returns GPUComputePassEncoder

beginRenderPass

• beginRenderPass(descriptor): GPURenderPassEncoder

• Begins encoding a render pass described by descriptor.

  Parameters

  • descriptor: GPURenderPassDescriptor

    Description of the GPURenderPassEncoder to create.

  Returns GPURenderPassEncoder

clearBuffer

• clearBuffer(buffer, offset?, size?): undefined

• Encode a command into the GPUCommandEncoder that fills a sub-region of a GPUBuffer with zeros.

  Parameters

  • buffer: GPUBuffer

    The GPUBuffer to clear.

  • Optional offset: number

    Offset in bytes into buffer where the sub-region to clear begins.

  • Optional size: number

    Size in bytes of the sub-region to clear. Defaults to the size of the buffer minus offset.

  Returns undefined

copyBufferToBuffer

• copyBufferToBuffer(source, sourceOffset, destination, destinationOffset, size): undefined

• Encode a command into the GPUCommandEncoder that copies data from a sub-region of a GPUBuffer to a sub-region of another GPUBuffer.

  Parameters

  • source: GPUBuffer

    The GPUBuffer to copy from.

  • sourceOffset: number

    Offset in bytes into source to begin copying from.

  • destination: GPUBuffer

    The GPUBuffer to copy to.

  • destinationOffset: number

    Offset in bytes into destination to place the copied data.

  • size: number

    Bytes to copy.

  Returns undefined

copyBufferToTexture

• copyBufferToTexture(source, destination, copySize): undefined

• Encode a command into the GPUCommandEncoder that copies data from a sub-region of a GPUBuffer to a sub-region of one or multiple continuous texture subresources.

  Parameters

  • source: GPUImageCopyBuffer

    Combined with copySize, defines the region of the source buffer.

  • destination: GPUImageCopyTexture

    Combined with copySize, defines the region of the destination texture subresource. copySize:

  • copySize: GPUExtent3DStrict

  Returns undefined

copyTextureToBuffer

• copyTextureToBuffer(source, destination, copySize): undefined

• Encode a command into the GPUCommandEncoder that copies data from a sub-region of one or multiple continuous texture subresources to a sub-region of a GPUBuffer.

  Parameters

  • source: GPUImageCopyTexture

    Combined with copySize, defines the region of the source texture subresources.

  • destination: GPUImageCopyBuffer

    Combined with copySize, defines the region of the destination buffer. copySize:

  • copySize: GPUExtent3DStrict

  Returns undefined

copyTextureToTexture

• copyTextureToTexture(source, destination, copySize): undefined

• Encode a command into the GPUCommandEncoder that copies data from a sub-region of one or multiple contiguous texture subresources to another sub-region of one or multiple continuous texture subresources.

  Parameters

  • source: GPUImageCopyTexture

    Combined with copySize, defines the region of the source texture subresources.

  • destination: GPUImageCopyTexture

    Combined with copySize, defines the region of the destination texture subresources. copySize:

  • copySize: GPUExtent3DStrict

  Returns undefined

finish

• finish(descriptor?): GPUCommandBuffer

• Completes recording of the commands sequence and returns a corresponding GPUCommandBuffer. descriptor:

  Parameters

  • Optional descriptor: GPUObjectDescriptorBase

  Returns GPUCommandBuffer

resolveQuerySet

• resolveQuerySet(querySet, firstQuery, queryCount, destination, destinationOffset): undefined

• Resolves query results from a GPUQuerySet out into a range of a GPUBuffer. querySet: firstQuery: queryCount: destination: destinationOffset:

  Parameters

  • querySet: GPUQuerySet

  • firstQuery: number

  • queryCount: number

  • destination: GPUBuffer

  • destinationOffset: number

  Returns undefined

writeTimestamp

• writeTimestamp(querySet, queryIndex): undefined

• Writes a timestamp value into a querySet when all previous commands have completed executing. Note: Timestamp query values are written in nanoseconds, but how the value is determined is implementation-defined and may not increase monotonically. See [[#timestamp]] for details.

  Parameters

  • querySet: GPUQuerySet

    The query set that will store the timestamp values.

  • queryIndex: number

    The index of the query in the query set.

  Returns undefined