GPUComputePassEncoder

Kotlin |Java

public final class GPUComputePassEncoder implements AutoCloseable

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

Summary

Public methods
`external void`	`close()`
`final external void`	`@FastNative dispatchWorkgroups( int workgroupCountX, int workgroupCountY, int workgroupCountZ )` Dispatches compute workgroups with explicitly defined counts.
`final external void`	`@FastNative dispatchWorkgroupsIndirect( @NonNull GPUBuffer indirectBuffer, long indirectOffset )` Dispatches compute workgroups using arguments from a buffer.
`final external void`	`@FastNative end()` Ends the compute pass.
`boolean`	`equals(Object other)`
`final long`	`getHandle()`
`int`	`hashCode()`
`final external void`	`@FastNative insertDebugMarker(@NonNull String markerLabel)` Inserts a debug marker command into the pass.
`final external void`	`@FastNative popDebugGroup()` Ends the most recently pushed debug group.
`final external void`	`@FastNative pushDebugGroup(@NonNull String groupLabel)` Starts a new named debug group.
`final external void`	`@FastNative setBindGroup( int groupIndex, GPUBindGroup group, @NonNull int[] dynamicOffsets )` Sets the bind group for a given index.
`final external void`	`@FastNative setLabel(@NonNull String label)` Sets a debug label for the compute pass encoder.
`final external void`	`@FastNative setPipeline(@NonNull GPUComputePipeline pipeline)` Sets the active compute pipeline.

public external void close()

@FastNative
public final external void dispatchWorkgroups(
    int workgroupCountX,
    int workgroupCountY,
    int workgroupCountZ
)

Dispatches compute workgroups with explicitly defined counts.

Parameters
`int workgroupCountX`	The number of workgroups to dispatch in the X dimension.
`int workgroupCountY`	The number of workgroups to dispatch in the Y dimension.
`int workgroupCountZ`	The number of workgroups to dispatch in the Z dimension.

@FastNative
public final external void dispatchWorkgroupsIndirect(
    @NonNull GPUBuffer indirectBuffer,
    long indirectOffset
)

Dispatches compute workgroups using arguments from a buffer.

Parameters
`@NonNull GPUBuffer indirectBuffer`	The buffer containing the dispatch arguments.
`long indirectOffset`	The offset in the buffer where dispatch arguments start.

@FastNative
public final external void end()

Ends the compute pass.

public boolean equals(Object other)

public final long getHandle()

public int hashCode()

@FastNative
public final external void insertDebugMarker(@NonNull String markerLabel)

Inserts a debug marker command into the pass.

Parameters
`@NonNull String markerLabel`	The label for the debug marker.

@FastNative
public final external void popDebugGroup()

Ends the most recently pushed debug group.

@FastNative
public final external void pushDebugGroup(@NonNull String groupLabel)

Starts a new named debug group.

Parameters
`@NonNull String groupLabel`	The label for the debug group.

@FastNative
public final external void setBindGroup(
    int groupIndex,
    GPUBindGroup group,
    @NonNull int[] dynamicOffsets
)

Sets the bind group for a given index.

Parameters
`int groupIndex`	The index of the bind group to set.
`GPUBindGroup group`	The bind group object to set.
`@NonNull int[] dynamicOffsets`	An array of dynamic offsets for uniform/storage buffers.

@FastNative
public final external void setLabel(@NonNull String label)

Sets a debug label for the compute pass encoder.

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

@FastNative
public final external void setPipeline(@NonNull GPUComputePipeline pipeline)

Sets the active compute pipeline.

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