Class WGLDriver

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

Readonlycontext

Readonlydiagnostics

Readonlygl

Readonlyprojections

Readonlyshaders

Readonlytextures

renderTarget

• get renderTarget(): RenderTarget

  Returns RenderTarget

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

clear

• clear(color: ColorLike): void

  Parameters

  • color: ColorLike

  Returns void

createRenderTarget

• createRenderTarget(textureHandle: TextureHandle): WGLRenderTarget

  Parameters

  • textureHandle: TextureHandle

  Returns WGLRenderTarget

finalizeFrame

• finalizeFrame(): void

  Finalize rendering for a frame.

  Returns void

initialize

• initialize(): Promise<void>

  Initialize the renderer and any context handlers.

  Returns Promise<void>

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.

removeLifeCycleHandler

• removeLifeCycleHandler(handler: RenderContextLifeCycleHandler): boolean

  Remove a handler.

  Parameters

  • handler: RenderContextLifeCycleHandler

    Handler

  Returns boolean

setCanvasDimensions

• setCanvasDimensions(dimensions: Vec2Like): void

  Parameters

  • dimensions: Vec2Like

  Returns void

uninitialize

• uninitialize(): Promise<void>

  Returns Promise<void>

useRenderTarget

• useRenderTarget(renderTarget: RenderTarget | "canvas"): void

  Parameters

  • renderTarget: RenderTarget | "canvas"

  Returns void

StaticfromCanvas

• 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>