GPUComputePassEncoder

Kotlin |Java

public final class GPUComputePassEncoder implements AutoCloseable

An object used to record commands for a compute pass.

Summary

Public methods
`external void`	`close()` Decrements the reference count of the object and frees resources when the count reaches zero.
`final external void`	`@FastNative dispatchWorkgroups( int workgroupCountX, int workgroupCountY, int workgroupCountZ )` Dispatches a compute shader.
`final external void`	`@FastNative dispatchWorkgroupsIndirect( @NonNull GPUBuffer indirectBuffer, long indirectOffset )` Dispatches a compute shader with parameters 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 into the command stream.
`final external void`	`@FastNative popDebugGroup()` Pops the current debug group.
`final external void`	`@FastNative pushDebugGroup(@NonNull String groupLabel)` Pushes a new debug group.
`final external void`	`@FastNative setBindGroup( int groupIndex, GPUBindGroup group, @NonNull int[] dynamicOffsets )` Sets a bind group for the pipeline.
`final external void`	`@FastNative setLabel(@NonNull String label)` Sets a human-readable label for debugging.
`final external void`	`@FastNative setPipeline(@NonNull GPUComputePipeline pipeline)` Sets the current compute pipeline.

public external void close()

Decrements the reference count of the object and frees resources when the count reaches zero.

This is the standard way to manage object lifetimes and should be used in use blocks. After calling this, the object is no longer usable.

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

Dispatches a compute shader.

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

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

Dispatches a compute shader with parameters from a buffer.

Parameters
`@NonNull GPUBuffer indirectBuffer`	The buffer containing the dispatch parameters.
`long indirectOffset`	The offset in the indirect buffer.

@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 into the command stream.

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

@FastNative
public final external void popDebugGroup()

Pops the current debug group.

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

Pushes a new 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 a bind group for the pipeline.

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

Sets a human-readable label for debugging.

Parameters
`@NonNull String label`	The label string.

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

Sets the current compute pipeline.

Parameters
`@NonNull GPUComputePipeline pipeline`	The compute pipeline to set.