Class WGLDriver

Implements

RenderDriver

Index

Constructors

Properties

context diagnostics gl projections shaders textures

Accessors

Methods

addLifeCycleHandler clear createRenderTarget finalizeFrame initialize prepareFrame removeLifeCycleHandler setCanvasDimensions uninitialize useRenderTarget fromCanvas

Constructors

constructor

new WGLDriver(
    canvas: CanvasLike,
    gl: WebGL2RenderingContext,
    context: RenderContext,
    projections: Projections,
    diagnostics?: RenderDiagnostics,
): WGLDriver
Parameters
- canvas: CanvasLike
- gl: WebGL2RenderingContext
- context: RenderContext
- projections: Projections
- diagnostics: RenderDiagnostics = ...
Returns WGLDriver
- Defined in rendering-webgl/driver.ts:59

Properties

`Readonly`context

context: RenderContext

Context.

`Readonly`diagnostics

diagnostics: RenderDiagnostics = ...

Diagnostics like frame time.

`Readonly`gl

gl: WebGL2RenderingContext

`Readonly`projections

projections: Projections

Projections.

`Readonly`shaders

shaders: WGLShaders

`Readonly`textures

textures: WGLTextures

Driver-specific texture manager.

Accessors

renderTarget

get renderTarget(): RenderTarget
Returns RenderTarget
Implementation of RenderDriver.renderTarget
- Defined in rendering-webgl/driver.ts:55

Methods

addLifeCycleHandler

addLifeCycleHandler<H extends RenderContextLifeCycleHandler>(handler: H): void
Register a new handler to be called on life cycle events.
Type Parameters
- H extends RenderContextLifeCycleHandler
Parameters
- handler: H
  Handler
Returns void
Implementation of RenderDriver.addLifeCycleHandler
- Defined in rendering-webgl/driver.ts:223

clear

clear(color: ColorLike): void
Parameters
- color: ColorLike
Returns void
- Defined in rendering-webgl/driver.ts:213

createRenderTarget

createRenderTarget(textureHandle: TextureHandle): WGLRenderTarget
Parameters
- textureHandle: TextureHandle
Returns WGLRenderTarget
- Defined in rendering-webgl/driver.ts:135

finalizeFrame

finalizeFrame(): void
Finalize rendering for a frame.

Returns void
Implementation of RenderDriver.finalizeFrame
- Defined in rendering-webgl/driver.ts:125

initialize

initialize(): Promise<void>
Initialize the renderer and any context handlers.

Returns Promise<void>
Implementation of RenderDriver.initialize
- Defined in rendering-webgl/driver.ts:233

prepareFrame

prepareFrame(): boolean
Call to prepare rendering a frame.

Returns boolean
false if preparation failed and rendering should not happen. Can be caused by WebGL context loss.
Implementation of RenderDriver.prepareFrame
- Defined in rendering-webgl/driver.ts:104

removeLifeCycleHandler

removeLifeCycleHandler(handler: RenderContextLifeCycleHandler): boolean
Remove a handler.
Parameters
- handler: RenderContextLifeCycleHandler
  Handler
Returns boolean
Implementation of RenderDriver.removeLifeCycleHandler
- Defined in rendering-webgl/driver.ts:229

setCanvasDimensions

setCanvasDimensions(dimensions: Vec2Like): void
Parameters
- dimensions: Vec2Like
Returns void
Implementation of RenderDriver.setCanvasDimensions
- Defined in rendering-webgl/driver.ts:131

uninitialize

uninitialize(): Promise<void>
Returns Promise<void>
- Defined in rendering-webgl/driver.ts:241

useRenderTarget

useRenderTarget(renderTarget: RenderTarget | "canvas"): void
Parameters
- renderTarget: RenderTarget | "canvas"
Returns void
Implementation of RenderDriver.useRenderTarget
- Defined in rendering-webgl/driver.ts:171

`Static`fromCanvas

fromCanvas(
    canvas: CanvasLike,
    options?: {
        contextAttrs?: WebGLContextAttributes;
        projectionsFactory?: (context: RenderContext) => Projections;
    },
): Promise<WGLDriver>
Parameters
- canvas: CanvasLike
- Optionaloptions: {
  contextAttrs?: WebGLContextAttributes;
  projectionsFactory?: (context: RenderContext) => Projections;
  }
Returns Promise<WGLDriver>
- Defined in rendering-webgl/driver.ts:249