kotlin-web/web.gpu/GPUComputePassEncoder

GPUComputePassEncoder

open class GPUComputePassEncoder : GPUBindingCommandsMixin, GPUDebugCommandsMixin, GPUObjectBase(source)

The GPUComputePassEncoder interface of the WebGPU API encodes commands related to controlling the compute shader stage, as issued by a GPUComputePipeline. It forms part of the overall encoding activity of a GPUCommandEncoder. Available only in secure contexts.

MDN Reference

Properties

label

open external var label: String

MDN Reference

Functions

dispatchWorkgroups

external fun dispatchWorkgroups(workgroupCountX: GPUSize32, workgroupCountY: GPUSize32 = definedExternally, workgroupCountZ: GPUSize32 = definedExternally)

The dispatchWorkgroups() method of the GPUComputePassEncoder interface dispatches a specific grid of workgroups to perform the work being done by the current GPUComputePipeline (i.e., set via GPUComputePassEncoder.setPipeline()).

dispatchWorkgroupsIndirect

external fun dispatchWorkgroupsIndirect(indirectBuffer: GPUBuffer, indirectOffset: GPUSize64)

The dispatchWorkgroupsIndirect() method of the GPUComputePassEncoder interface dispatches a grid of workgroups, defined by the parameters of a GPUBuffer, to perform the work being done by the current GPUComputePipeline (i.e., set via GPUComputePassEncoder.setPipeline()).

end

external fun end()

The end() method of the GPUComputePassEncoder interface completes recording of the current compute pass command sequence.

insertDebugMarker

open external fun insertDebugMarker(markerLabel: String)

MDN Reference

popDebugGroup

open external fun popDebugGroup()

MDN Reference

pushDebugGroup

open external fun pushDebugGroup(groupLabel: String)

MDN Reference

setBindGroup

open external fun setBindGroup(index: GPUIndex32, bindGroup: GPUBindGroup?, dynamicOffsets: ReadonlyArray<GPUBufferDynamicOffset> = definedExternally)

MDN Reference

open external fun setBindGroup(index: GPUIndex32, bindGroup: GPUBindGroup?, dynamicOffsetsData: Uint32Array<ArrayBufferLike>, dynamicOffsetsDataStart: GPUSize64, dynamicOffsetsDataLength: GPUSize32)

setPipeline

external fun setPipeline(pipeline: GPUComputePipeline)

The setPipeline() method of the GPUComputePassEncoder interface sets the GPUComputePipeline to use for this compute pass.