WebGpuUtils

Added in 1.0.0-alpha06

public final class WebGpuUtils


Summary

Public methods

static final @NonNull WebGpu
createWebGpu(
    Surface surface,
    @NonNull GPUInstanceDescriptor instanceDescriptor,
    @NonNull GPURequestAdapterOptions requestAdapterOptions,
    @NonNull GPUDeviceDescriptor deviceDescriptor
)

Creates a WebGpu environment using a newly created default single-threaded dispatcher.

static final @NonNull WebGpu
createWebGpu(
    @NonNull CoroutineDispatcher dispatcher,
    Surface surface,
    @NonNull GPUInstanceDescriptor instanceDescriptor,
    @NonNull GPURequestAdapterOptions requestAdapterOptions,
    @NonNull GPUDeviceDescriptor deviceDescriptor
)

Creates a WebGpu environment using the provided dispatcher.

static final void

Initializes the native library.

Public methods

createWebGpu

public static final @NonNull WebGpu createWebGpu(
    Surface surface,
    @NonNull GPUInstanceDescriptor instanceDescriptor,
    @NonNull GPURequestAdapterOptions requestAdapterOptions,
    @NonNull GPUDeviceDescriptor deviceDescriptor
)

Creates a WebGpu environment using a newly created default single-threaded dispatcher.

Parameters
Surface surface

An optional Android Surface to bind to WebGPU.

@NonNull GPUInstanceDescriptor instanceDescriptor

Options for configuring the native WebGPU instance.

@NonNull GPURequestAdapterOptions requestAdapterOptions

Options for selecting the GPU adapter (e.g., backend type).

@NonNull GPUDeviceDescriptor deviceDescriptor

Options for requesting the GPU device.

Returns
@NonNull WebGpu

A configured WebGpu instance.

createWebGpu

public static final @NonNull WebGpu createWebGpu(
    @NonNull CoroutineDispatcher dispatcher,
    Surface surface,
    @NonNull GPUInstanceDescriptor instanceDescriptor,
    @NonNull GPURequestAdapterOptions requestAdapterOptions,
    @NonNull GPUDeviceDescriptor deviceDescriptor
)

Creates a WebGpu environment using the provided dispatcher.

Parameters
@NonNull CoroutineDispatcher dispatcher

A custom CoroutineDispatcher to use for executing WebGPU JNI operations. Must be single-threaded.

Surface surface

An optional Android Surface to bind to WebGPU.

@NonNull GPUInstanceDescriptor instanceDescriptor

Options for configuring the native WebGPU instance.

@NonNull GPURequestAdapterOptions requestAdapterOptions

Options for selecting the GPU adapter (e.g., backend type).

@NonNull GPUDeviceDescriptor deviceDescriptor

Options for requesting the GPU device.

Returns
@NonNull WebGpu

A configured WebGpu instance.

initLibrary

public static final void initLibrary()

Initializes the native library. This method should be called before making and WebGPU calls.