Interface GPUCommandEncoder

Hierarchy

GPUObjectBase
GPUCommandsMixin
GPUDebugCommandsMixin
- GPUCommandEncoder

Index

Properties

Methods

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

Properties

label

label: string

Methods

beginComputePass

beginComputePass(descriptor?: GPUComputePassDescriptor): GPUComputePassEncoder
Parameters
- Optional descriptor: GPUComputePassDescriptor
Returns GPUComputePassEncoder
- Defined in dist/index.d.ts:2342

beginRenderPass

beginRenderPass(descriptor: GPURenderPassDescriptor): GPURenderPassEncoder
Begins encoding a render pass described by descriptor.
Parameters
- descriptor: GPURenderPassDescriptor
  
  Description of the GPURenderPassEncoder to create.
Returns GPURenderPassEncoder
- Defined in dist/index.d.ts:2339

clearBuffer

clearBuffer(buffer: GPUBuffer, offset?: number, size?: number): 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
- Defined in dist/index.d.ts:2413

copyBufferToBuffer

copyBufferToBuffer(source: GPUBuffer, destination: GPUBuffer, size?: number): undefined
Shorthand, equivalent to copyBufferToBuffer.
Parameters
- source: GPUBuffer
- destination: GPUBuffer
- Optional size: number
Returns undefined
- Defined in dist/index.d.ts:2348
copyBufferToBuffer(source: GPUBuffer, sourceOffset: number, destination: GPUBuffer, destinationOffset: number, size?: number): 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.
- Optional size: number
  
  Bytes to copy. Defaults to the size of the buffer source minus sourceOffset.
Returns undefined
- Defined in dist/index.d.ts:2362

copyBufferToTexture

copyBufferToTexture(source: GPUTexelCopyBufferInfo, destination: GPUTexelCopyTextureInfo, copySize: GPUExtent3DStrict): 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: GPUTexelCopyBufferInfo
  
  Combined with copySize, defines the region of the source buffer.
- destination: GPUTexelCopyTextureInfo
  
  Combined with copySize, defines the region of the destination texture subresource. copySize:
- copySize: GPUExtent3DStrict
Returns undefined
- Defined in dist/index.d.ts:2376

copyTextureToBuffer

copyTextureToBuffer(source: GPUTexelCopyTextureInfo, destination: GPUTexelCopyBufferInfo, copySize: GPUExtent3DStrict): 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: GPUTexelCopyTextureInfo
  
  Combined with copySize, defines the region of the source texture subresources.
- destination: GPUTexelCopyBufferInfo
  
  Combined with copySize, defines the region of the destination buffer. copySize:
- copySize: GPUExtent3DStrict
Returns undefined
- Defined in dist/index.d.ts:2388

copyTextureToTexture

copyTextureToTexture(source: GPUTexelCopyTextureInfo, destination: GPUTexelCopyTextureInfo, copySize: GPUExtent3DStrict): 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: GPUTexelCopyTextureInfo
  
  Combined with copySize, defines the region of the source texture subresources.
- destination: GPUTexelCopyTextureInfo
  
  Combined with copySize, defines the region of the destination texture subresources. copySize:
- copySize: GPUExtent3DStrict
Returns undefined
- Defined in dist/index.d.ts:2401

finish

finish(descriptor?: GPUObjectDescriptorBase): GPUCommandBuffer
Completes recording of the commands sequence and returns a corresponding GPUCommandBuffer. descriptor:
Parameters
- Optional descriptor: GPUObjectDescriptorBase
Returns GPUCommandBuffer
- Defined in dist/index.d.ts:2437

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
Inherited from GPUDebugCommandsMixin.insertDebugMarker
- Defined in dist/index.d.ts:1947

popDebugGroup

popDebugGroup(): undefined
Ends the labeled debug group most recently started by pushDebugGroup.

Returns undefined
Inherited from GPUDebugCommandsMixin.popDebugGroup
- Defined in dist/index.d.ts:1942

pushDebugGroup

pushDebugGroup(groupLabel: string): undefined
Begins a labeled debug group containing subsequent commands.
Parameters
- groupLabel: string
  
  The label for the command group.
Returns undefined
Inherited from GPUDebugCommandsMixin.pushDebugGroup
- Defined in dist/index.d.ts:1936

resolveQuerySet

resolveQuerySet(querySet: GPUQuerySet, firstQuery: number, queryCount: number, destination: GPUBuffer, destinationOffset: number): 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
- Defined in dist/index.d.ts:2426

Interface GPUCommandEncoder

Hierarchy

Index

Properties

Methods

Properties

label

Methods

beginComputePass

Parameters

Optional descriptor: GPUComputePassDescriptor

Returns GPUComputePassEncoder

beginRenderPass

Parameters

descriptor: GPURenderPassDescriptor

Returns GPURenderPassEncoder

clearBuffer

Parameters

buffer: GPUBuffer

Optional offset: number

Optional size: number

Returns undefined

copyBufferToBuffer

Parameters

source: GPUBuffer

destination: GPUBuffer

Optional size: number

Returns undefined

Parameters

source: GPUBuffer

sourceOffset: number

destination: GPUBuffer

destinationOffset: number

Optional size: number

Returns undefined

copyBufferToTexture

Parameters

source: GPUTexelCopyBufferInfo

destination: GPUTexelCopyTextureInfo

copySize: GPUExtent3DStrict

Returns undefined

copyTextureToBuffer

Parameters

source: GPUTexelCopyTextureInfo

destination: GPUTexelCopyBufferInfo

copySize: GPUExtent3DStrict

Returns undefined

copyTextureToTexture

Parameters

source: GPUTexelCopyTextureInfo

destination: GPUTexelCopyTextureInfo

copySize: GPUExtent3DStrict

Returns undefined

finish

Parameters

Optional descriptor: GPUObjectDescriptorBase

Returns GPUCommandBuffer

insertDebugMarker

Parameters

markerLabel: string

Returns undefined

popDebugGroup

Returns undefined

pushDebugGroup

Parameters

groupLabel: string

Returns undefined

resolveQuerySet

Parameters

querySet: GPUQuerySet

firstQuery: number

queryCount: number

destination: GPUBuffer

destinationOffset: number

Returns undefined

Settings

Member Visibility

Theme

`Optional` descriptor: GPUComputePassDescriptor

`Optional` offset: number

`Optional` size: number

`Optional` size: number

`Optional` size: number

`Optional` descriptor: GPUObjectDescriptorBase