Class Gl

constructor

• new Gl(
      ...source:
          | [HTMLCanvasElement, WebGLContextAttributes?]
          | [WebGLRenderingContext],
  ): Gl

  Parameters

  • ...source: [HTMLCanvasElement, WebGLContextAttributes?] | [WebGLRenderingContext]

  Returns Gl

Readonlyhandle

ReadonlyinstancedArraysExtension

ReadonlyminMaxExtension

ReadonlysrgbExtension

height

• get height(): number

  Get the height of the drawing buffer.

  Returns number

width

• get width(): number

  Get the width of the drawing buffer.

  Returns number

arrayBuffer

• arrayBuffer(
      data?: null | number[] | Float32Array<ArrayBufferLike>,
      usage?: BufferUsage,
  ): ArrayBuffer

  Parameters

  • data: null | number[] | Float32Array<ArrayBufferLike> = null
  • usage: BufferUsage = BufferUsage.Dynamic

  Returns ArrayBuffer

clearBuffers

• clearBuffers(): this

  Clear color and depth buffer

  Returns this

clearColorBuffer

• clearColorBuffer(): this

  Returns this

clearDepthBuffer

• clearDepthBuffer(): this

  Returns this

command

• command<
      Uniforms extends TypeMap,
      Attributes extends TypeMap,
      Instances extends TypeMap,
      Varyings extends TypeMap = {},
  >(
      primitivesType: PrimitivesType,
      configOrSource:
          | SourceConfig<Uniforms, Attributes, Instances, Varyings>
          | ProgramSource<
              WithoutPrecision<Uniforms>,
              WithoutPrecision<Attributes>,
              WithoutPrecision<Instances>,
          >,
  ): Command<
      WithoutPrecision<Uniforms>,
      WithoutPrecision<Attributes>,
      WithoutPrecision<Instances>,
  >

  The main function of this library, creates a command with specified parameters and shaders

  Type Parameters

  • Uniforms extends TypeMap
  • Attributes extends TypeMap
  • Instances extends TypeMap
  • Varyings extends TypeMap = {}

  Parameters

  • primitivesType: PrimitivesType

    Type of primitives to draw

  • configOrSource:
        | SourceConfig<Uniforms, Attributes, Instances, Varyings>
        | ProgramSource<
            WithoutPrecision<Uniforms>,
            WithoutPrecision<Attributes>,
            WithoutPrecision<Instances>,
        >

    Description of attributes, uniforms, varyings, and shaders

  Returns Command<
      WithoutPrecision<Uniforms>,
      WithoutPrecision<Attributes>,
      WithoutPrecision<Instances>,
  >

dispose

• dispose(): void

  Destroy WebGL context

  Returns void

drawArrays

• drawArrays(primitivesType: PrimitivesType, verticesCount: number): this

  Parameters

  • primitivesType: PrimitivesType
  • verticesCount: number

  Returns this

drawInstancedArrays

• drawInstancedArrays(
      primitivesType: PrimitivesType,
      verticesCount: number,
      instancesCount: number,
  ): this

  Parameters

  • primitivesType: PrimitivesType
  • verticesCount: number
  • instancesCount: number

  Returns this

drawsElements

• drawsElements(primitivesType: PrimitivesType, elementsCount: number): this

  Parameters

  • primitivesType: PrimitivesType
  • elementsCount: number

  Returns this

drawsInstancedElements

• drawsInstancedElements(
      primitivesType: PrimitivesType,
      elementsCount: number,
      instancesCount: number,
  ): this

  Parameters

  • primitivesType: PrimitivesType
  • elementsCount: number
  • instancesCount: number

  Returns this

elementsBuffer

• elementsBuffer(
      data?: null | number[] | Uint16Array<ArrayBufferLike>,
      usage?: BufferUsage,
  ): ElementsBuffer

  Parameters

  • data: null | number[] | Uint16Array<ArrayBufferLike> = null
  • usage: BufferUsage = BufferUsage.Dynamic

  Returns ElementsBuffer

frameBuffer

• frameBuffer(texture: Texture, renderBuffer?: RenderBuffer): FrameBuffer

  Create a frame buffer that can be used as a render target.

  Parameters

  • texture: Texture

    The texture to attach to the frame buffer.

  • OptionalrenderBuffer: RenderBuffer

    Depth buffer to attach to the frame buffer.

  Returns FrameBuffer

getErrorCode

• getErrorCode(): number

  Returns number

getPointSizeRange

• getPointSizeRange(): [number, number]

  Returns [number, number]

hasSrgbExtension

• hasSrgbExtension(): boolean

  Returns boolean

isContextLost

• isContextLost(): boolean

  Returns boolean

program

• program(vertex: string, fragment: string): Program

  Create a program with a specified vertex and fragment shader source

  Parameters

  • vertex: string
  • fragment: string

  Returns Program

read

• read(format?: PixelFormat): Uint8Array

  Read pixels from a drawing buffer into an array buffer

  Parameters

  • format: PixelFormat = PixelFormat.Rgba

  Returns Uint8Array

renderBuffer

• renderBuffer(width: number, height: number): RenderBuffer

  Create depth buffer with specified width and height

  Parameters

  • width: number

    Depth buffer width

  • height: number

    Depth buffer height

  Returns RenderBuffer

settings

• settings(): Settings

  Create an empty settings object

  Returns Settings

texture

• texture(config: TextureConfig): Texture

  Create texture with specified parameters

  Parameters

  • config: TextureConfig

  Returns Texture