Class Gl

Hierarchy

Gl

Implements

Disposable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in src/webgl.ts:522
Parameters
- Rest ...source: [HTMLCanvasElement, undefined | WebGLContextAttributes] | [WebGLRenderingContext]
Returns Gl

Properties

Readonly handle

handle: WebGLRenderingContext

Readonly instancedArrays

instancedArrays: ANGLE_instanced_arrays

Private Readonly settingsCache

settingsCache: SettingsCache = SettingsCache.initial()

Methods

arrayBuffer

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

- Defined in src/webgl.ts:597
Parameters
- Default value data: Float32Array | number[] | null = null
- Default value usage: BufferUsage = BufferUsage.Dynamic
Returns ArrayBuffer

cleanBuffers

cleanBuffers(): this

- Defined in src/webgl.ts:552
Clear color and depth buffer

Returns this

cleanColorBuffer

cleanColorBuffer(): this

- Defined in src/webgl.ts:541
Returns this

cleanDepthBuffer

cleanDepthBuffer(): this

- Defined in src/webgl.ts:545
Returns this

command

command<Uniforms, Attributes, Instances, Varyings>(primitivesType: PrimitivesType, config: SourceConfig<Uniforms, Attributes, Instances, Varyings>): Command<WithoutPrecision<Uniforms>, WithoutPrecision<Attributes>, WithoutPrecision<Instances>>

- Defined in src/webgl.ts:622
The main function of this library, creates a command with specified parameters and shaders

Type parameters
- Uniforms: TypeMap
- Attributes: TypeMap
- Instances: TypeMap
- Varyings: TypeMap = {}
Parameters
- primitivesType: PrimitivesType
  
  Type of primitives to draw
- config: SourceConfig<Uniforms, Attributes, Instances, Varyings>
  
  Description of attributes, uniforms, varyings, and shaders
Returns Command<WithoutPrecision<Uniforms>, WithoutPrecision<Attributes>, WithoutPrecision<Instances>>

dispose

dispose(): void

- Defined in src/webgl.ts:637
Destroy WebGL context

Returns void

drawArrays

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

- Defined in src/webgl.ts:557
Parameters
- primitivesType: PrimitivesType
- verticesCount: number
Returns this

drawInstancedArrays

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

- Defined in src/webgl.ts:565
Parameters
- primitivesType: PrimitivesType
- verticesCount: number
- instancesCount: number
Returns this

drawsElements

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

- Defined in src/webgl.ts:561
Parameters
- primitivesType: PrimitivesType
- elementsCount: number
Returns this

drawsInstancedElements

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

- Defined in src/webgl.ts:569
Parameters
- primitivesType: PrimitivesType
- elementsCount: number
- instancesCount: number
Returns this

elementsBuffer

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

- Defined in src/webgl.ts:600
Parameters
- Default value data: Uint16Array | number[] | null = null
- Default value usage: BufferUsage = BufferUsage.Dynamic
Returns ElementsBuffer

frameBuffer

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

- Defined in src/webgl.ts:593
Parameters
- texture: Texture
- Optional renderBuffer: RenderBuffer
Returns FrameBuffer

getPointSizeRange

getPointSizeRange(): [number, number]

- Defined in src/webgl.ts:538
Returns [number, number]

isContextLost

isContextLost(): boolean

- Defined in src/webgl.ts:534
Returns boolean

program

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

- Defined in src/webgl.ts:607
Create program with specified vertex and fragment shader source

Parameters
- vertex: string
- fragment: string
Returns Program

renderBuffer

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

- Defined in src/webgl.ts:589
Parameters
- width: number
  
  Depth buffer
- height: number
Returns RenderBuffer

settings

settings(): Settings

- Defined in src/webgl.ts:577
Create empty settings object

Returns Settings

texture

texture(config: TextureConfig): Texture

- Defined in src/webgl.ts:581
Parameters
- config: TextureConfig
Returns Texture

Generated using TypeDoc