Class WgCanvas

Describes a render target based on an HTMLCanvasElement

Hierarchy

WgRenderTarget
- WgCanvas

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WgCanvas(context: WgContext, width: number, height: number): WgCanvas

Overrides WgRenderTarget.constructor
- Defined in backend/src/catana/webgpu/wg-canvas.ts:16
Sets up a WebGPU render target based on a newly created HTMLCanvasElement

Parameters
- context: WgContext
  
  The WebGPU context
- width: number
  
  The canvas width (therefore also the render target width)
- height: number
  
  The canvas height (therefore also the render target height)
Returns WgCanvas

Properties

Private Readonly _format

_format: GPUTextureFormat

Private Readonly canvas

canvas: HTMLCanvasElement

Private Readonly ctx

ctx: GPUCanvasContext

Protected Readonly webGpuContext

webGpuContext: WgContext

Accessors

domElement

get domElement(): HTMLCanvasElement

- Defined in backend/src/catana/webgpu/wg-canvas.ts:48
Returns HTMLCanvasElement

The HTMLCanvasElement on which the rendering is taking place

format

get format(): GPUTextureFormat

Overrides WgRenderTarget.format
- Defined in backend/src/catana/webgpu/wg-canvas.ts:82
Returns GPUTextureFormat

height

get height(): number

Inherited from WgRenderTarget.height
- Defined in backend/src/catana/webgpu/wg-render-target.ts:26
Returns number

texture

get texture(): GPUTexture

Overrides WgRenderTarget.texture
- Defined in backend/src/catana/webgpu/wg-canvas.ts:74
Returns GPUTexture

view

get view(): GPUTextureView

Overrides WgRenderTarget.view
- Defined in backend/src/catana/webgpu/wg-canvas.ts:78
Returns GPUTextureView

width

get width(): number

Inherited from WgRenderTarget.width
- Defined in backend/src/catana/webgpu/wg-render-target.ts:25
Returns number

Methods

dispose

dispose(): void

Overrides WgRenderTarget.dispose
- Defined in backend/src/catana/webgpu/wg-canvas.ts:68
Unconfigure the Canvas's WebGPU context and remove the HTMLCanvasElement from the DOM tree

Returns void

setSize

setSize(width: number, height: number): void

Overrides WgRenderTarget.setSize
- Defined in backend/src/catana/webgpu/wg-canvas.ts:57
Resets the size of this render target, of the HTMLCanvasElement, and also reconfigure the Canvas's WebGPU context

Parameters
- width: number
  
  The new width
- height: number
  
  The new height
Returns void

Generated using TypeDoc