Class WebGLContextWrapper

constructor

• new WebGLContextWrapper(gl, canvas): WebGLContextWrapper

• Creates a new WebGLContextWrapper instance.

  Parameters

  • gl: WebGL2RenderingContext

    The WebGL2 rendering context to wrap
  • canvas: HTMLCanvasElement

    The HTML canvas element associated with the context

  Returns WebGLContextWrapper

__extensions

__gl

__webglVersion

_isWebXRMode

Readonlycanvas

height

Optional Readonlywebgl1ExtBM

Optional Readonlywebgl1ExtCBF

Optional Readonlywebgl1ExtCTAstc

Optional Readonlywebgl1ExtCTAtc

Optional Readonlywebgl1ExtCTBptc

Optional Readonlywebgl1ExtCTEtc

Optional Readonlywebgl1ExtCTEtc1

Optional Readonlywebgl1ExtCTPvrtc

Optional Readonlywebgl1ExtCTS3tc

Optional Readonlywebgl1ExtDB

Optional Readonlywebgl1ExtDRV

Optional Readonlywebgl1ExtEIUI

Optional Readonlywebgl1ExtIA

Optional Readonlywebgl1ExtSTL

Optional Readonlywebgl1ExtTF

Optional Readonlywebgl1ExtTFA

Optional Readonlywebgl1ExtTFL

Optional Readonlywebgl1ExtTHF

Optional Readonlywebgl1ExtTHFL

Optional Readonlywebgl1ExtVAO

Optional Readonlywebgl2ExtCBF

Optional Readonlywebgl2ExtCBHF

Optional Readonlywebgl2ExtCTAstc

Optional Readonlywebgl2ExtCTAtc

Optional Readonlywebgl2ExtCTBptc

Optional Readonlywebgl2ExtCTEtc

Optional Readonlywebgl2ExtCTEtc1

Optional Readonlywebgl2ExtCTPvrtc

Optional Readonlywebgl2ExtCTS3tc

Optional Readonlywebgl2ExtClipCtrl

Optional Readonlywebgl2ExtGmanWM

Optional Readonlywebgl2ExtMLTVIEW

Optional Readonlywebgl2ExtTFA

Optional Readonlywebgl2ExtTFL

Optional Readonlywebgl2ExtTHFL

width

defaultViewport

• get defaultViewport(): Vector4

• Gets the default viewport settings.

  Returns Vector4

  A Vector4 containing default viewport left, top, width, and height

isWebGL2

• get isWebGL2(): boolean

• Checks if the current context is WebGL2.

  Returns boolean

  True if WebGL2, false if WebGL1

viewport

• get viewport(): Vector4

• Gets the current viewport settings.

  Returns Vector4

  A Vector4 containing viewport left, top, width, and height

bindTexture2D

• bindTexture2D(activeTextureIndex, texture): void

• Binds a 2D texture to a specific texture unit. Optimized to avoid redundant state changes.

  Parameters

  • activeTextureIndex: number

    The texture unit index
  • texture: WebGLTexture

    The 2D texture to bind

  Returns void

bindTexture2DArray

• bindTexture2DArray(activeTextureIndex, texture): void

• Binds a 2D array texture to a specific texture unit. Optimized to avoid redundant state changes.

  Parameters

  • activeTextureIndex: number

    The texture unit index
  • texture: WebGLTexture

    The 2D array texture to bind

  Returns void

bindTextureCube

• bindTextureCube(activeTextureIndex, texture): void

• Binds a cube map texture to a specific texture unit. Optimized to avoid redundant state changes.

  Parameters

  • activeTextureIndex: number

    The texture unit index
  • texture: WebGLTexture

    The cube map texture to bind

  Returns void

bindTextureSampler

• bindTextureSampler(activeTextureIndex, sampler): void

• Binds a sampler object to a specific texture unit. Optimized to avoid redundant state changes.

  Parameters

  • activeTextureIndex: number

    The texture unit index
  • sampler: WebGLSampler

    The sampler object to bind

  Returns void

bindVertexArray

• bindVertexArray(vao): void

• Binds a vertex array object.

  Parameters

  • vao: null | WebGLVertexArrayObjectOES

    The vertex array object to bind, or null to unbind

  Returns void

colorAttachment

• colorAttachment(index): number

• Gets the color attachment constant for a given index.

  Parameters

  • index: number

    The attachment index

  Returns number

  The WebGL color attachment constant

createVertexArray

• createVertexArray(): null | WebGLVertexArrayObject

• Creates a new vertex array object.

  Returns null | WebGLVertexArrayObject

  A new WebGL vertex array object

deleteVertexArray

• deleteVertexArray(vertexArray): void

• Deletes a vertex array object.

  Parameters

  • vertexArray: WebGLVertexArrayObjectOES | WebGLVertexArrayObject

    The vertex array object to delete

  Returns void

drawArraysInstanced

• drawArraysInstanced(primitiveMode, first, count, instanceCount): void

• Draws arrays with instancing support.

  Parameters

  • primitiveMode: number

    The primitive mode (GL_TRIANGLES, etc.)
  • first: number

    The starting index in the enabled arrays
  • count: number

    The number of vertices to draw
  • instanceCount: number

    The number of instances to draw

  Returns void

drawBuffers

• drawBuffers(buffers): void

• Sets the draw buffers for multiple render targets.

  Parameters

  • buffers: RenderBufferTargetEnum[]

    Array of render buffer targets to draw to

  Returns void

drawElementsInstanced

• drawElementsInstanced(primitiveMode, indexCount, type, offset, instanceCount): void

• Draws elements with instancing support.

  Parameters

  • primitiveMode: number

    The primitive mode (GL_TRIANGLES, etc.)
  • indexCount: number

    The number of indices to draw
  • type: number

    The type of the index values
  • offset: number

    The offset in the index buffer
  • instanceCount: number

    The number of instances to draw

  Returns void

getAlignedMaxUniformBlockSize

• getAlignedMaxUniformBlockSize(): number

• Gets the maximum uniform block size aligned to the required offset alignment.

  Returns number

  The aligned maximum uniform block size in bytes

getIsWebGL2

• getIsWebGL2(gl): gl is WebGL2RenderingContext

• Type guard to check if the context is WebGL2.

  Parameters

  • gl: WebGLRenderingContext | WebGL2RenderingContext

    The WebGL context to check

  Returns gl is WebGL2RenderingContext

  True if the context is WebGL2, false otherwise

getMaxConventionUniformBlocks

• getMaxConventionUniformBlocks(): number

• Gets the maximum number of uniform blocks that can be used in both vertex and fragment shaders.

  Returns number

  The minimum of vertex and fragment shader uniform block limits

getMaxFragmentUniformVectors

• getMaxFragmentUniformVectors(): number

• Gets the maximum number of uniform vectors available in fragment shaders.

  Returns number

  The maximum fragment uniform vectors

getMaxVertexUniformVectors

• getMaxVertexUniformVectors(): number

• Gets the maximum number of uniform vectors available in vertex shaders.

  Returns number

  The maximum vertex uniform vectors

getRawContext

• getRawContext(): WebGLRenderingContext | WebGL2RenderingContext

• Gets the raw WebGL rendering context.

  Returns WebGLRenderingContext | WebGL2RenderingContext

  The underlying WebGL context (WebGL1 or WebGL2)

getRawContextAsWebGL1

• getRawContextAsWebGL1(): WebGLRenderingContext

• Gets the raw WebGL context cast as WebGL1.

  Returns WebGLRenderingContext

  The underlying WebGL context as WebGL1 type

getRawContextAsWebGL2

• getRawContextAsWebGL2(): WebGL2RenderingContext

• Gets the raw WebGL context cast as WebGL2.

  Returns WebGL2RenderingContext

  The underlying WebGL context as WebGL2 type

getWebGLMemoryInfo

• getWebGLMemoryInfo(): any

• Gets WebGL memory usage information if the GMAN_WEBGL_MEMORY extension is available.

  Returns any

  Memory information object or undefined if extension is not available

isMultiview

• isMultiview(): boolean

• Checks if multiview rendering is supported and enabled.

  Returns boolean

  True if multiview is available and enabled for WebVR

isNotSupportWebGL1Extension

• isNotSupportWebGL1Extension(webGLExtension): boolean

• Checks if a WebGL1 extension is not supported.

  Parameters

  • webGLExtension: EnumIO

    The WebGL extension to check

  Returns boolean

  True if the extension is not supported, false otherwise

isSupportWebGL1Extension

• isSupportWebGL1Extension(webGLExtension): boolean

• Checks if a WebGL1 extension is supported.

  Parameters

  • webGLExtension: EnumIO

    The WebGL extension to check

  Returns boolean

  True if the extension is supported, false otherwise

setViewport

• setViewport(left, top, width, height): void

• Sets the viewport with optimization to avoid redundant state changes.

  Parameters

  • left: number

    Left coordinate of the viewport
  • top: number

    Top coordinate of the viewport
  • width: number

    Width of the viewport
  • height: number

    Height of the viewport

  Returns void

setViewportAsVector4

• setViewportAsVector4(viewport): void

• Sets the viewport using a Vector4 with optimization to avoid redundant state changes.

  Parameters

  • viewport: Vector4

    Vector4 containing left, top, width, and height

  Returns void

unbindTexture2D

• unbindTexture2D(activeTextureIndex): void

• Unbinds a 2D texture from a specific texture unit.

  Parameters

  • activeTextureIndex: number

    The texture unit index

  Returns void

unbindTexture2DArray

• unbindTexture2DArray(activeTextureIndex): void

• Unbinds a 2D array texture from a specific texture unit.

  Parameters

  • activeTextureIndex: number

    The texture unit index

  Returns void

unbindTextureCube

• unbindTextureCube(activeTextureIndex): void

• Unbinds a cube map texture from a specific texture unit.

  Parameters

  • activeTextureIndex: number

    The texture unit index

  Returns void

unbindTextures

• unbindTextures(): void

• Unbinds all currently bound textures from all texture units. This is useful for cleanup operations.

  Returns void

vertexAttribDivisor

• vertexAttribDivisor(index, divisor): void

• Sets the divisor for instanced rendering for a vertex attribute.

  Parameters

  • index: number

    The index of the vertex attribute
  • divisor: number

    The divisor value (0 for per-vertex, 1+ for per-instance)

  Returns void