Class WgPass

Describes a WebGPU pass that can be used in a WgAlgorithm to create a pipeline

Hierarchy

WgPass

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new WgPass(encode: EncodeFun, info: PassInfo): WgPass

- Defined in backend/src/catana/webgpu/wg-pass.ts:64
Parameters
- encode: EncodeFun
- info: PassInfo
Returns WgPass

Properties

Readonly encode

encode: EncodeFun

Readonly info

Static Private Readonly debug_outputs

debug_outputs: Map<string, WgBuffer<any>[]> = new Map<string, WgBuffer<any>[]>()

Methods

Static Private buffName

buffName(b: WgBuffer<any>): string

- Defined in backend/src/catana/webgpu/wg-pass.ts:212
Parameters
- b: WgBuffer<any>
Returns string

Static Private compName

compName(s: WgCompShader): string

- Defined in backend/src/catana/webgpu/wg-pass.ts:216
Parameters
- s: WgCompShader
Returns string

Static createCompShaderPass

createCompShaderPass(context: WgContext, compShader: WgCompShader): WgPass

- Defined in backend/src/catana/webgpu/wg-pass.ts:106
Creates a compute pass (that executes a compute shader)

Parameters
- context: WgContext
  
  The WebGPU context
- compShader: WgCompShader
  
  The compute shader to be executed
Returns WgPass

Static createCopyPass

createCopyPass<T>(context: WgContext, src: WgBuffer<T>, dst: WgBuffer<T>, srcOffset?: number, dstOffset?: number, byteSize?: undefined | number): WgPass

- Defined in backend/src/catana/webgpu/wg-pass.ts:80
Creates a copy pass, copying (in the GPU) the contents of one source buffer into a destination buffer

Type parameters
- T: WgBufferDataType
Parameters
- context: WgContext
  
  The WebGPU context
- src: WgBuffer<T>
  
  The source buffer (to be copied from)
- dst: WgBuffer<T>
  
  The destination buffer (to be copied into)
- Default value srcOffset: number = 0
  
  The offset of the source buffer (where to begin copying from)
- Default value dstOffset: number = 0
  
  The offset of the destination buffer (where to begin copying into)
- Optional byteSize: undefined | number
  
  The size/length (in bytes) of the data to copy
Returns WgPass

Static createFillPass

createFillPass(context: WgContext, buffer: WgBuffer<any>, value: number): WgPass

- Defined in backend/src/catana/webgpu/wg-pass.ts:140
Creates a fill pass (that fills the contents of a buffer with a uniform scalar value)

Parameters
- context: WgContext
  
  The WebGPU context
- buffer: WgBuffer<any>
  
  The buffer to fill
- value: number
  
  The value to fill the buffer with
Returns WgPass

Static createRenderPass

createRenderPass(context: WgContext, rendShader: WgRendShader): WgPass

- Defined in backend/src/catana/webgpu/wg-pass.ts:162
Creates a render pass (that executes render operations)

Parameters
- context: WgContext
  
  The WebGPU context
- rendShader: WgRendShader
  
  The rendering shader
Returns WgPass

Static deleteOutputs

deleteOutputs(debug: string): void

- Defined in backend/src/catana/webgpu/wg-pass.ts:40
See WgPass.getOutputs

Parameters
- debug: string
Returns void

Static getOutputs

getOutputs(debug: string): null | WgBuffer<any>[]

- Defined in backend/src/catana/webgpu/wg-pass.ts:31
Outputs are a mechanic to use during debugging, to enable that the contents of a buffer can be read on the CPU (and printed) to facilitate debugging

Parameters
- debug: string
  
  The name of the debugging instance
Returns null | WgBuffer<any>[]

Static printOutputs

printOutputs(debug: string): Promise<void>

- Defined in backend/src/catana/webgpu/wg-pass.ts:50
See WgPass.getOutputs

Parameters
- debug: string
Returns Promise<void>

Static Private rendName

rendName(s: WgRendShader): string

- Defined in backend/src/catana/webgpu/wg-pass.ts:225
Parameters
- s: WgRendShader
Returns string

Generated using TypeDoc