Interface WebGLContext

A WebGL context object, including the rendering context, resource caches and counts

Hierarchy

  • WebGLContext

Properties

clear contextRestored createRenderTarget destroy extensions getDrawingBufferPixelData gl handleContextRestored isContextLost isWebGL2 max3dTextureSize maxDrawBuffers maxRenderbufferSize maxTextureImageUnits maxTextureSize namedComputeRenderables namedFramebuffers namedTextures pixelRatio readPixels readPixelsAsync resources setContextLost state stats timer unbindFramebuffer waitForGpuCommandsComplete waitForGpuCommandsCompleteSync

Properties

clear

clear: ((red: number, green: number, blue: number, alpha: number) => void)

Type declaration

    • (red: number, green: number, blue: number, alpha: number): void

    • Parameters

      • red: number
      • green: number
      • blue: number
      • alpha: number

      Returns void

Readonly contextRestored

contextRestored: BehaviorSubject<Timestamp>

createRenderTarget

createRenderTarget: ((width: number, height: number, depth?: boolean, type?: "uint8" | "float32" | "fp16", filter?: TextureFilter) => RenderTarget)

Type declaration

    • (width: number, height: number, depth?: boolean, type?: "uint8" | "float32" | "fp16", filter?: TextureFilter): RenderTarget

    • Parameters

      • width: number
      • height: number
      • Optional depth: boolean
      • Optional type: "uint8" | "float32" | "fp16"
      • Optional filter: TextureFilter

      Returns RenderTarget

destroy

destroy: ((options?: Partial<{ doNotForceWebGLContextLoss: boolean }>) => void)

Type declaration

    • (options?: Partial<{ doNotForceWebGLContextLoss: boolean }>): void

    • Parameters

      • Optional options: Partial<{ doNotForceWebGLContextLoss: boolean }>

      Returns void

Readonly extensions

extensions: WebGLExtensions

getDrawingBufferPixelData

getDrawingBufferPixelData: (() => PixelData)

Type declaration

Readonly gl

gl: GLRenderingContext

handleContextRestored

handleContextRestored: ((extraResets?: (() => void)) => void)

Type declaration

    • (extraResets?: (() => void)): void

    • Parameters

      • Optional extraResets: (() => void)
          • (): void

          • Returns void

      Returns void

Readonly isContextLost

isContextLost: boolean

Readonly isWebGL2

isWebGL2: boolean

Readonly max3dTextureSize

max3dTextureSize: number

Readonly maxDrawBuffers

maxDrawBuffers: number

Readonly maxRenderbufferSize

maxRenderbufferSize: number

Readonly maxTextureImageUnits

maxTextureImageUnits: number

Readonly maxTextureSize

maxTextureSize: number

Readonly namedComputeRenderables

namedComputeRenderables: { [name: string]: ComputeRenderable<any> }

Cache for compute renderables, managed by consumers

Type declaration

Readonly namedFramebuffers

namedFramebuffers: { [name: string]: Framebuffer }

Cache for frambuffers, managed by consumers

Type declaration

Readonly namedTextures

namedTextures: { [name: string]: Texture }

Cache for textures, managed by consumers

Type declaration

Readonly pixelRatio

pixelRatio: number

readPixels

readPixels: ((x: number, y: number, width: number, height: number, buffer: Uint8Array | Int32Array | Float32Array) => void)

Type declaration

    • (x: number, y: number, width: number, height: number, buffer: Uint8Array | Int32Array | Float32Array): void

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • buffer: Uint8Array | Int32Array | Float32Array

      Returns void

readPixelsAsync

readPixelsAsync: ((x: number, y: number, width: number, height: number, buffer: Uint8Array) => Promise<void>)

Type declaration

    • (x: number, y: number, width: number, height: number, buffer: Uint8Array): Promise<void>

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • buffer: Uint8Array

      Returns Promise<void>

Readonly resources

resources: WebGLResources

setContextLost

setContextLost: (() => void)

Type declaration

    • (): void

    • Returns void

Readonly state

state: WebGLState

Readonly stats

stats: { drawCount: number; instanceCount: number; instancedDrawCount: number; resourceCounts: { attribute: number; elements: number; framebuffer: number; program: number; renderbuffer: number; shader: number; texture: number; vertexArray: number } }

Type declaration

  • drawCount: number
  • instanceCount: number
  • instancedDrawCount: number
  • resourceCounts: { attribute: number; elements: number; framebuffer: number; program: number; renderbuffer: number; shader: number; texture: number; vertexArray: number }
    • attribute: number
    • elements: number
    • framebuffer: number
    • program: number
    • renderbuffer: number
    • shader: number
    • texture: number
    • vertexArray: number

Readonly timer

timer: WebGLTimer

unbindFramebuffer

unbindFramebuffer: (() => void)

Type declaration

    • (): void

    • Returns void

waitForGpuCommandsComplete

waitForGpuCommandsComplete: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

waitForGpuCommandsCompleteSync

waitForGpuCommandsCompleteSync: (() => void)

Type declaration

    • (): void

    • Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc