Class WgContext

The WebGPU context, powering all WebGPU features that Catana will use

Hierarchy

WgContext

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

Private constructor

new WgContext(adapter: GPUAdapter, device: GPUDevice, gpu: GPU, features: GPUFeatureName[]): WgContext

- Defined in backend/src/catana/webgpu/wg-context.ts:40
Parameters
- adapter: GPUAdapter
- device: GPUDevice
- gpu: GPU
- features: GPUFeatureName[]
Returns WgContext

Properties

Private Readonly _adapter

_adapter: GPUAdapter

Private Readonly _device

_device: GPUDevice

Private Readonly _gpu

_gpu: GPU

Private cache

cache: Cache<any> = new Cache<any>()

Private Readonly features

features: GPUFeatureName[]

Accessors

adapter

get adapter(): GPUAdapter

- Defined in backend/src/catana/webgpu/wg-context.ts:68
Returns GPUAdapter

device

get device(): GPUDevice

- Defined in backend/src/catana/webgpu/wg-context.ts:64
Returns GPUDevice

gpu

get gpu(): GPU

- Defined in backend/src/catana/webgpu/wg-context.ts:72
Returns GPU

Methods

getCache

getCache<PipelineType>(code: string, createPipelineFun: (module: GPUShaderModule) => PipelineType): CacheData<PipelineType>

- Defined in backend/src/catana/webgpu/wg-context.ts:55
In order to avoid keeping many instances of the same GPUShaderModule, this cache stores the already-created GPUShaderModules as a mapping of their code (VERY inefficient, TODO: improve)

Type parameters
- PipelineType: GPUPipelineBase
Parameters
- code: string
  
  The shader code
- createPipelineFun: (module: GPUShaderModule) => PipelineType
  
  A function to create a pipeline based on a given GPUShaderModule
  - - (module: GPUShaderModule): PipelineType
    - Parameters
      - module: GPUShaderModule
      Returns PipelineType
Returns CacheData<PipelineType>

supportsFeature

supportsFeature(feature: "timestamp-query"): boolean

- Defined in backend/src/catana/webgpu/wg-context.ts:81
Parameters
- feature: "timestamp-query"
  
  The feature which may or may not be supported by the GPU
Returns boolean

True if 'feature' is supported by the GPU, False otherwise

Static get

get(): Promise<WgContext | string>

- Defined in backend/src/catana/webgpu/wg-context.ts:102
Creates a new WebGPU context if WebGPU could be initialized

Returns Promise<WgContext | string>

If WebGPU could be initialized, a new WebGPU context Otherwise, a string explaining why WebGPU could not be initialized

Static isSupported

isSupported(): boolean

- Defined in backend/src/catana/webgpu/wg-context.ts:92
Whether WebGPU is supported

Returns boolean

Generated using TypeDoc