Class WebGPUContext

constructor

• new WebGPUContext(memory: Memory, device: GPUDevice): WebGPUContext

  Parameters

  • memory: Memory
  • device: GPUDevice

  Returns WebGPUContext

device

memory

bindCanvas

• bindCanvas(canvas: HTMLCanvasElement): void

  Bind a canvas element to the runtime.

  Parameters

  • canvas: HTMLCanvasElement

    The HTML canvas/

  Returns void

clearCanvas

• clearCanvas(): void

  Clear canvas

  Returns void

copyRawBytesToBuffer

• copyRawBytesToBuffer(
      rawBytes: Uint8Array,
      toPtr: number,
      toOffset: number,
      nbytes: number,
  ): void

  Copy raw bytes into buffer ptr.

  Parameters

  • rawBytes: Uint8Array

    The raw bytes

  • toPtr: number

    The target gpu buffer ptr

  • toOffset: number

    The beginning offset

  • nbytes: number

    Number of bytes

  Returns void

createShader

• createShader(finfo: FunctionInfo, code: string): Function

  Create a PackedFunc that runs the given shader via createComputePipeline

  Parameters

  • finfo: FunctionInfo

    The function information already parsed as a record.

  • code: string

    The shader data(in WGSL)

  Returns Function

  The shader

createShaderAsync

• createShaderAsync(finfo: FunctionInfo, code: string): Promise<Function>

  Create a PackedFunc that runs the given shader asynchronously via createComputePipelineAsync

  Parameters

  • finfo: FunctionInfo

    The function information already parsed as a record.

  • code: string

    The shader data(in WGSL)

  Returns Promise<Function>

  The shader

dispose

• dispose(): void

  Dispose context.

  Returns void

drawImageFromBuffer

• drawImageFromBuffer(ptr: number, height: number, width: number): void

  Draw image from data in storage buffer.

  Parameters

  • ptr: number

    The GPU ptr

  • height: number

    The height of the image.

  • width: number

    The width of the image.

  Returns void

getDeviceAPI

• getDeviceAPI(name: string): Function

  Get the device API according to its name *

  Parameters

  • name: string

    The name of the API.

  Returns Function

  The corresponding device api.

runtimeStatsText

• runtimeStatsText(): string

  Obtain the runtime information in readable format.

  Returns string

sync

• sync(): Promise<void>

  Wait for all pending GPU tasks to complete

  Returns Promise<void>