GPUComputePassEncoder

Kotlin |Java

class GPUComputePassEncoder : AutoCloseable

Used to record compute pipeline dispatch commands within a command encoder.

Summary

Public functions
`open external Unit`	`close()`
`external Unit`	`@FastNative dispatchWorkgroups( workgroupCountX: Int, workgroupCountY: Int, workgroupCountZ: Int )` Dispatches compute workgroups with explicitly defined counts.
`external Unit`	`@FastNative dispatchWorkgroupsIndirect( indirectBuffer: GPUBuffer, indirectOffset: Long )` Dispatches compute workgroups using arguments from a buffer.
`external Unit`	`@FastNative end()` Ends the compute pass.
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`external Unit`	`@FastNative insertDebugMarker(markerLabel: String)` Inserts a debug marker command into the pass.
`external Unit`	`@FastNative popDebugGroup()` Ends the most recently pushed debug group.
`external Unit`	`@FastNative pushDebugGroup(groupLabel: String)` Starts a new named debug group.
`external Unit`	`@FastNative setBindGroup( groupIndex: Int, group: GPUBindGroup?, dynamicOffsets: IntArray )` Sets the bind group for a given index.
`external Unit`	`@FastNative setLabel(label: String)` Sets a debug label for the compute pass encoder.
`external Unit`	`@FastNative setPipeline(pipeline: GPUComputePipeline)` Sets the active compute pipeline.

Public properties
`Long`	`handle`

open external fun close(): Unit

@FastNative
external fun dispatchWorkgroups(
    workgroupCountX: Int,
    workgroupCountY: Int = 1,
    workgroupCountZ: Int = 1
): Unit

Dispatches compute workgroups with explicitly defined counts.

Parameters
`workgroupCountX: Int`	The number of workgroups to dispatch in the X dimension.
`workgroupCountY: Int = 1`	The number of workgroups to dispatch in the Y dimension.
`workgroupCountZ: Int = 1`	The number of workgroups to dispatch in the Z dimension.

@FastNative
external fun dispatchWorkgroupsIndirect(
    indirectBuffer: GPUBuffer,
    indirectOffset: Long
): Unit

Dispatches compute workgroups using arguments from a buffer.

Parameters
`indirectBuffer: GPUBuffer`	The buffer containing the dispatch arguments.
`indirectOffset: Long`	The offset in the buffer where dispatch arguments start.

@FastNative
external fun end(): Unit

Ends the compute pass.

open operator fun equals(other: Any?): Boolean

open fun hashCode(): Int

@FastNative
external fun insertDebugMarker(markerLabel: String): Unit

Inserts a debug marker command into the pass.

Parameters
`markerLabel: String`	The label for the debug marker.

@FastNative
external fun popDebugGroup(): Unit

Ends the most recently pushed debug group.

@FastNative
external fun pushDebugGroup(groupLabel: String): Unit

Starts a new named debug group.

Parameters
`groupLabel: String`	The label for the debug group.

@FastNative
external fun setBindGroup(
    groupIndex: Int,
    group: GPUBindGroup? = null,
    dynamicOffsets: IntArray = intArrayOf()
): Unit

Sets the bind group for a given index.

Parameters
`groupIndex: Int`	The index of the bind group to set.
`group: GPUBindGroup? = null`	The bind group object to set.
`dynamicOffsets: IntArray = intArrayOf()`	An array of dynamic offsets for uniform/storage buffers.

@FastNative
external fun setLabel(label: String): Unit

Sets a debug label for the compute pass encoder.

Parameters
`label: String`	The label to assign to the compute pass encoder.

@FastNative
external fun setPipeline(pipeline: GPUComputePipeline): Unit

Sets the active compute pipeline.

Parameters
`pipeline: GPUComputePipeline`	The compute pipeline to use for subsequent dispatch calls.

val handle: Long