Class Canvas3D

A canvas to interact with WebGL.

Hierarchy (View Summary)

Canvas
- Canvas3D

Index

Constructors

Properties

Accessors

context height width

Methods

clearWith refreshCanvasNode render renderFpsInfo update

Constructors

constructor

new Canvas3D(canvas: HTMLCanvasElement): Canvas3D
Constructs a new Canvas3D.
Parameters
- canvas: HTMLCanvasElement
  The canvas to wrap.
Returns Canvas3D
Overrides Canvas.constructor
- Defined in source/graphics/canvas3d.ts:25

Properties

`Readonly`canvasElement

canvasElement: HTMLCanvasElement | OffscreenCanvas

The canvas element we're interacting with.

Accessors

context

get context(): WebGL2RenderingContext
Retrieves the rendering context of the canvas.

Returns WebGL2RenderingContext
The rendering context of the canvas.
- Defined in source/graphics/canvas3d.ts:17

height

get height(): number
Retrieves the height of the canvas.

Returns number
The height of the canvas.
Inherited from Canvas.height
- Defined in source/graphics/canvas.ts:28

width

get width(): number
Retrieves the width of the canvas.

Returns number
The width of the canvas.
Inherited from Canvas.width
- Defined in source/graphics/canvas.ts:20

Methods

clearWith

clearWith(_color: number): void
Not supported.
Parameters
- _color: number
  Ignored
Returns void
Overrides Canvas.clearWith
- Defined in source/graphics/canvas3d.ts:66

refreshCanvasNode

refreshCanvasNode(): void
Recreate internal buffers in reaction to a change in our target HTMLCanvasElement.

Returns void
Overrides Canvas.refreshCanvasNode
- Defined in source/graphics/canvas3d.ts:39

render

render(): void
Does nothing.

Returns void
Overrides Canvas.render
- Defined in source/graphics/canvas3d.ts:58

renderFpsInfo

renderFpsInfo(
    _frameTimes: number[],
    _frameTime: number,
    _timeDelta: number,
): void
Not supported.
Parameters
- _frameTimes: number[]
  Ignored.
- _frameTime: number
  Ignored.
- _timeDelta: number
  Ignored.
Returns void
Overrides Canvas.renderFpsInfo
- Defined in source/graphics/canvas3d.ts:76

update

update(): void
Does nothing.

Returns void
Overrides Canvas.update
- Defined in source/graphics/canvas3d.ts:52