Class Compute

constructor

• new Compute(graphicsDevice, shader, name?): Compute

• Create a compute instance. Note that this is supported on WebGPU only and is a no-op on other platforms.

  Parameters

  • graphicsDevice: GraphicsDevice

    The graphics device.
  • shader: Shader

    The compute shader.
  • Optional name: string = 'Unnamed'

    The name of the compute instance, used for debugging only.

  Returns Compute

name

deleteParameter

• deleteParameter(name): void

• Deletes a shader parameter from the compute instance.

  Parameters

  • name: string

    The name of the parameter to delete.

  Returns void

getParameter

• getParameter(name): number | number[] | Float32Array | VertexBuffer | Texture | StorageBuffer | IndexBuffer

• Returns the value of a shader parameter from the compute instance.

  Parameters

  • name: string

    The name of the parameter to get.

  Returns number | number[] | Float32Array | VertexBuffer | Texture | StorageBuffer | IndexBuffer

  The value of the specified parameter.

setParameter

• setParameter(name, value): void

• Sets a shader parameter on a compute instance.

  Parameters

  • name: string

    The name of the parameter to set.
  • value: number | number[] | Float32Array | VertexBuffer | Texture | StorageBuffer | IndexBuffer

    The value for the specified parameter.

  Returns void

setupDispatch

• setupDispatch(x, y?, z?): void

• Prepare the compute work dispatch.

  Parameters

  • x: number

    X dimension of the grid of work-groups to dispatch.
  • Optional y: number

    Y dimension of the grid of work-groups to dispatch.
  • Optional z: number

    Z dimension of the grid of work-groups to dispatch.

  Returns void