Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebGLContext

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

Hierarchy

  • WebGLContext

Index

Properties

Methods

Properties

Readonly contextRestored

contextRestored: BehaviorSubject<Timestamp>

Readonly extensions

extensions: WebGLExtensions

Readonly gl

gl: GLRenderingContext

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: {}

Cache for compute renderables, managed by consumers

Type declaration

Readonly namedFramebuffers

namedFramebuffers: {}

Cache for frambuffers, managed by consumers

Type declaration

Readonly namedTextures

namedTextures: {}

Cache for textures, managed by consumers

Type declaration

Readonly pixelRatio

pixelRatio: number

Readonly resources

resources: WebGLResources

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

Methods

clear

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

  • Parameters

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

    Returns void

createRenderTarget

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

  • Parameters

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

    Returns void

getDrawingBufferPixelData

  • Returns PixelData

handleContextRestored

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

  • Parameters

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

        • Returns void

    Returns void

readPixels

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

  • Parameters

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

    Returns void

readPixelsAsync

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

setContextLost

  • setContextLost(): void

  • Returns void

unbindFramebuffer

  • unbindFramebuffer(): void

  • Returns void

waitForGpuCommandsComplete

  • waitForGpuCommandsComplete(): Promise<void>

  • Returns Promise<void>

waitForGpuCommandsCompleteSync

  • waitForGpuCommandsCompleteSync(): void

  • Returns void

Generated using TypeDoc