npm i dan-shari-gl --save

Index

Classes

Interfaces

Functions

Variables

Const ALIGN_CENTER

ALIGN_CENTER: 1 = 1

Const ALIGN_LEFT

ALIGN_LEFT: 0 = 0

Const ALIGN_RIGHT

ALIGN_RIGHT: 2 = 2

Const CAP_HEIGHTS

CAP_HEIGHTS: string[] = ['H', 'I', 'N', 'E', 'F', 'K', 'L', 'T', 'U', 'V', 'W', 'X', 'Y', 'Z']

Const CLAMP_TO_EDGE

CLAMP_TO_EDGE: number = 33071

Const COLOR_REPEAT

COLOR_REPEAT: 4 = 4

Const DEPTH_COMPONENT16

DEPTH_COMPONENT16: number = 33189

Const EMPTY_CANVAS_COLOR

EMPTY_CANVAS_COLOR: "#ff0000" = "#ff0000"

Const EMPTY_CANVAS_SIZE

EMPTY_CANVAS_SIZE: 16 = 16

Const FLOAT

FLOAT: number = 5126

Const LINEAR

LINEAR: number = 9729

Const LINEAR_MIPMAP_LINEAR

LINEAR_MIPMAP_LINEAR: number = 9987

Const LINEAR_MIPMAP_NEAREST

LINEAR_MIPMAP_NEAREST: number = 9985

Const M_WIDTHS

M_WIDTHS: string[] = ['m', 'w']

Const NEAREST

NEAREST: number = 9728

Const NEAREST_MIPMAP_LINEAR

NEAREST_MIPMAP_LINEAR: number = 9986

Const NEAREST_MIPMAP_NEAREST

NEAREST_MIPMAP_NEAREST: number = 9984

Const REPEAT

REPEAT: number = 10497

Const RGB

RGB: number = 6407

Const SPACE_ID

SPACE_ID: number = ' '.charCodeAt(0)

Const TAB_ID

TAB_ID: number = '\t'.charCodeAt(0)

Const UNIFORM_1F

UNIFORM_1F: "1f" = "1f"

Const UNIFORM_1I

UNIFORM_1I: "1i" = "1i"

Const UNIFORM_2F

UNIFORM_2F: "2f" = "2f"

Const UNIFORM_3F

UNIFORM_3F: "3f" = "3f"

Const UNIFORM_MAT_4F

UNIFORM_MAT_4F: "mat4" = "mat4"

Const UNSIGNED_BYTE

UNSIGNED_BYTE: number = 5121

Const X_HEIGHTS

X_HEIGHTS: string[] = ['x', 'e', 'a', 'o', 'n', 's', 'r', 'c', 'u', 'm', 'v', 'w', 'z']

Const fillFragShader

fillFragShader: "precision highp float;varying vec2 vUv;void main(){gl_FragColor = vec4(vUv, 0.0, 1.0);}" = `precision highp float;varying vec2 vUv;void main(){gl_FragColor = vec4(vUv, 0.0, 1.0);}`

Const fullscreenVertShader

fullscreenVertShader: "precision highp float;attribute vec3 position;uniform vec2 px;varying vec2 vUv;void main(){vUv = vec2(0.5)+(position.xy)*0.5;gl_Position = vec4(position, 1.0);}" = `precision highp float;attribute vec3 position;uniform vec2 px;varying vec2 vUv;void main(){vUv = vec2(0.5)+(position.xy)*0.5;gl_Position = vec4(position, 1.0);}`

Const newline

newline: RegExp = /\n/

Const newlineChar

newlineChar: "" = ""

Const texFragShader

texFragShader: "precision highp float;uniform sampler2D uTexture;varying vec2 vUv;void main(){vec4 texColor = texture2D(uTexture, vUv);gl_FragColor = texColor;}" = `precision highp float;uniform sampler2D uTexture;varying vec2 vUv;void main(){vec4 texColor = texture2D(uTexture, vUv);gl_FragColor = texColor;}`

Const whitespace

whitespace: RegExp = /\s/

Functions

activeTexture

activeTexture(gl: WebGLRenderingContext, texture: WebGLTexture, uniformLocation: WebGLUniformLocation, textureNum?: number): void

- Defined in utils/functions/gl-textures.ts:157
Parameters
- gl: WebGLRenderingContext
- texture: WebGLTexture
- uniformLocation: WebGLUniformLocation
- Default value textureNum: number = 0
Returns void

addKeyword

addKeyword(sources: string, keywords: string | null): string

- Defined in utils/functions/gl-functions.ts:276
Parameters
- sources: string
- keywords: string | null
Returns string

addLineNumbers

addLineNumbers(text: string): string

- Defined in utils/functions/gl-functions.ts:32
display error of shader.

Parameters
- text: string
Returns string

bindBuffer

bindBuffer(gl: WebGLRenderingContext, buffer: WebGLBuffer, location?: number, size?: number, type?: number, normalized?: boolean, stride?: number, offset?: number, isBind?: boolean): void

- Defined in utils/functions/gl-functions.ts:196
Parameters
- gl: WebGLRenderingContext
- buffer: WebGLBuffer
- Default value location: number = 0
- Default value size: number = 1
- Default value type: number = FLOAT
- Default value normalized: boolean = false
- Default value stride: number = 0
- Default value offset: number = 0
- Default value isBind: boolean = true
Returns void

calculateCircleCenter

calculateCircleCenter(A: Vector3, B: Vector3, C: Vector3): object

- Defined in math/math.ts:11
Parameters
- A: Vector3
- B: Vector3
- C: Vector3
Returns object
- x: number
- y: number
- z: number

castMouse

castMouse(mouse: vec2, viewMatrixInverse: mat4, projectionMatrixInverse: mat4, depth?: number): vec3

- Defined in utils/functions/gl-functions.ts:244
Parameters
- mouse: vec2
- viewMatrixInverse: mat4
- projectionMatrixInverse: mat4
- Default value depth: number = 0
Returns vec3

clamp

clamp(value: number, min: number, max: number): number

- Defined in math/math.ts:2
Parameters
- value: number
- min: number
- max: number
Returns number

compileGLShader

compileGLShader(gl: WebGLRenderingContext, glType: number, shaderSource: string): undefined | WebGLShader

- Defined in utils/functions/gl-functions.ts:48
compile webgl shader

Parameters
- gl: WebGLRenderingContext
- glType: number
- shaderSource: string
Returns undefined | WebGLShader

createAndBindDepthBuffer

createAndBindDepthBuffer(gl: WebGLRenderingContext, width: number, height: number): null | WebGLRenderbuffer

- Defined in utils/functions/gl-functions.ts:268
Parameters
- gl: WebGLRenderingContext
- width: number
- height: number
Returns null | WebGLRenderbuffer

createBuffer

createBuffer(gl: WebGLRenderingContext, data: Float32Array): null | WebGLBuffer

- Defined in utils/functions/gl-functions.ts:140
creates and initializes WebGLBuffer with data

Parameters
- gl: WebGLRenderingContext
- data: Float32Array
Returns null | WebGLBuffer

createBufferWithLocation

createBufferWithLocation(gl: WebGLRenderingContext, program: WebGLProgram, data: Float32Array, str: string): object

- Defined in utils/functions/gl-functions.ts:119
create buffer and get location from program

Parameters
- gl: WebGLRenderingContext
- program: WebGLProgram
- data: Float32Array
- str: string
Returns object

uniformLocation
- buffer: null | WebGLBuffer
- location: number

createCustomTypeImageTexture

createCustomTypeImageTexture(gl: WebGLRenderingContext, canvasImage: HTMLImageElement | HTMLCanvasElement, format?: number, type: number, isFlip?: boolean, isMipmap?: boolean): null | WebGLTexture

- Defined in utils/functions/gl-textures.ts:60
Parameters
- gl: WebGLRenderingContext
- canvasImage: HTMLImageElement | HTMLCanvasElement
- Default value format: number = RGB
- type: number
- Default value isFlip: boolean = false
- Default value isMipmap: boolean = false
Returns null | WebGLTexture

createEmptyTexture

createEmptyTexture(gl: WebGLRenderingContext, textureWidth: number, textureHeight: number, format?: number, minFilter?: number, magFilter?: number, wrapS?: number, wrapT?: number, type?: number): WebGLTexture

- Defined in utils/functions/gl-textures.ts:15
Parameters
- gl: WebGLRenderingContext
- textureWidth: number
- textureHeight: number
- Default value format: number = RGB
- Default value minFilter: number = LINEAR
- Default value magFilter: number = LINEAR
- Default value wrapS: number = CLAMP_TO_EDGE
- Default value wrapT: number = CLAMP_TO_EDGE
- Default value type: number = UNSIGNED_BYTE
Returns WebGLTexture

createFrameBufferWithTexture

createFrameBufferWithTexture(gl: WebGLRenderingContext, texture: WebGLTexture): null | WebGLFramebuffer

- Defined in utils/functions/gl-functions.ts:260
Parameters
- gl: WebGLRenderingContext
- texture: WebGLTexture
Returns null | WebGLFramebuffer

createImageTexture

createImageTexture(gl: WebGLRenderingContext, canvasImage: HTMLImageElement | HTMLCanvasElement, format?: number, isFlip?: boolean, isMipmap?: boolean): null | WebGLTexture

- Defined in utils/functions/gl-textures.ts:43
Parameters
- gl: WebGLRenderingContext
- canvasImage: HTMLImageElement | HTMLCanvasElement
- Default value format: number = RGB
- Default value isFlip: boolean = false
- Default value isMipmap: boolean = false
Returns null | WebGLTexture

createIndex

createIndex(gl: WebGLRenderingContext, indices: Uint16Array | Uint32Array): object

- Defined in utils/functions/gl-functions.ts:176
make index buffer

Parameters
- gl: WebGLRenderingContext
- indices: Uint16Array | Uint32Array
Returns object
- buffer: null | WebGLBuffer
- cnt: number

createProgram

createProgram(gl: WebGLRenderingContext, vertexShaderSrc: string, fragmentShaderSrc: string): WebGLProgram

- Defined in utils/functions/gl-functions.ts:78
Parameters
- gl: WebGLRenderingContext
- vertexShaderSrc: string
- fragmentShaderSrc: string
Returns WebGLProgram

createSimpleBox

createSimpleBox(): object

- Defined in utils/generate/generateSimpleGeometry.ts:2
Returns object
- indices: number[]
- normals: number[]
- uvs: number[]
- vertices: number[]

createSimplePlane

createSimplePlane(): object

- Defined in utils/generate/generateSimpleGeometry.ts:280
Returns object
- indices: number[]
- normals: number[]
- uvs: number[]
- vertices: number[]

createSuperSimpleplane

createSuperSimpleplane(scaleX?: number, scaleY?: number): Float32Array

- Defined in utils/generate/generateSimpleGeometry.ts:320
Parameters
- Default value scaleX: number = 1
- Default value scaleY: number = 1
Returns Float32Array

degToRad

degToRad(value: number): number

- Defined in math/math.ts:34
Parameters
- value: number
Returns number

findChar

findChar(fontChars: any, value: any): string | -1

- Defined in extra/textLayout.ts:368
Parameters
- fontChars: any
- value: any
Returns string | -1

generateFaceFromIndex

generateFaceFromIndex(vertices: number[], indices: number[]): [vec3, vec3, vec3][]

- Defined in utils/functions/gl-functions.ts:214
Parameters
- vertices: number[]
- indices: number[]
Returns [vec3, vec3, vec3][]

getAjaxJson

getAjaxJson(url: string, callback: Function): void

- Defined in utils/functions/assets-functions.ts:9
load json with ajax

Parameters
- url: string
  
  url to load json file
- callback: Function
Returns void

getCapHeight

getCapHeight(font: any): any

- Defined in extra/textLayout.ts:385
Parameters
- font: any
Returns any

getGlyphById

getGlyphById(font: any, id: any): any

- Defined in extra/textLayout.ts:377
Parameters
- font: any
- id: any
Returns any

getImage

getImage(imageUrl: string, callback: Function): void

- Defined in utils/functions/assets-functions.ts:35
Parameters
- imageUrl: string
- callback: Function
Returns void

getKerning

getKerning(font: any, lastId: any, nextId: any): any

- Defined in extra/textLayout.ts:346
Parameters
- font: any
- lastId: any
- nextId: any
Returns any

getPlane

getPlane(width: number, height: number, widthSegment: number, heightSegment: number): object

- Defined in utils/generate/generateGeometry.ts:49
Parameters
- width: number
- height: number
- widthSegment: number
- heightSegment: number
Returns object
- indices: number[]
- uvs: number[]
- vertices: number[]

getSphere

getSphere(radius?: number, latitudeBands?: number, longitudeBands?: number): object

- Defined in utils/generate/generateGeometry.ts:1
Parameters
- Default value radius: number = 2
- Default value latitudeBands: number = 64
- Default value longitudeBands: number = 64
Returns object
- indices: number[]
- normals: number[]
- uvs: number[]
- vertices: number[]

getUniformLocations

getUniformLocations(gl: WebGLRenderingContext, program: WebGLProgram, arr: string[]): IUniformObject

- Defined in utils/functions/gl-functions.ts:9
Parameters
- gl: WebGLRenderingContext
- program: WebGLProgram
- arr: string[]
Returns IUniformObject

getXHeight

getXHeight(font: any): any

- Defined in extra/textLayout.ts:359
Parameters
- font: any
Returns any

isPowerOf2

isPowerOf2(value: number): boolean

- Defined in utils/functions/gl-textures.ts:88
Parameters
- value: number
Returns boolean

loadDraco

loadDraco(dracoUrl: string, callback: Function): void

- Defined in utils/functions/assets-functions.ts:55
Parameters
- dracoUrl: string
- callback: Function
  
  https://github.com/kioku-systemk/dracoSample/blob/5611528416d4e0afb10cbec52d70493602d8a552/dracoloader.js#L210
Returns void

mergeGeomtory

mergeGeomtory(geometries: object[]): object

- Defined in utils/generate/generateGeometry.ts:97
Parameters
- geometries: object[]
Returns object
- indices: number[]
- normals: number[]
- uvs: number[]
- vertices: number[]

mix

mix(x: number, y: number, a: number): number

- Defined in math/math.ts:30
Parameters
- x: number
- y: number
- a: number
Returns number

number

number(num: any, def: any): number

- Defined in extra/textLayout.ts:13
Parameters
- num: any
- def: any
Returns number

radToDeg

radToDeg(value: number): number

- Defined in math/math.ts:39
Parameters
- value: number
Returns number

range

range(min: number, max: number): number

- Defined in math/math.ts:6
Parameters
- min: number
- max: number
Returns number

updateArrayBuffer

updateArrayBuffer(gl: WebGLRenderingContext, buffer: WebGLBuffer, data: Float32Array, isBind?: boolean): void

- Defined in utils/functions/gl-functions.ts:157
update array buffer

Parameters
- gl: WebGLRenderingContext
- buffer: WebGLBuffer
- data: Float32Array
- Default value isBind: boolean = true
Returns void

updateEmptyImageTexture

updateEmptyImageTexture(gl: WebGLRenderingContext, texture: WebGLTexture, textureWidth: number, textureHeight: number, format?: number, minFilter?: number, magFilter?: number, wrapS?: number, wrapT?: number, type?: number): WebGLTexture

- Defined in utils/functions/gl-textures.ts:120
Parameters
- gl: WebGLRenderingContext
- texture: WebGLTexture
- textureWidth: number
- textureHeight: number
- Default value format: number = RGB
- Default value minFilter: number = LINEAR
- Default value magFilter: number = LINEAR
- Default value wrapS: number = CLAMP_TO_EDGE
- Default value wrapT: number = CLAMP_TO_EDGE
- Default value type: number = UNSIGNED_BYTE
Returns WebGLTexture

updateImageTexture

updateImageTexture(gl: WebGLRenderingContext, texture: WebGLTexture, image: HTMLImageElement, format?: number): void

- Defined in utils/functions/gl-textures.ts:99
Parameters
- gl: WebGLRenderingContext
- texture: WebGLTexture
- image: HTMLImageElement
- Default value format: number = RGB
Returns void

Generated using TypeDoc

dan-shari-gl

minimum webgl framework

Install

API Documents

Examples

Tools

this library is being developed with alexjoverm/typescript-library-starter

Useful Tools

Color

Index

Classes

Interfaces

Variables

Functions

Variables

Const ALIGN_CENTER

Const ALIGN_LEFT

Const ALIGN_RIGHT

Const CAP_HEIGHTS

Const CLAMP_TO_EDGE

Const COLOR_REPEAT

Const DEPTH_COMPONENT16

Const EMPTY_CANVAS_COLOR

Const EMPTY_CANVAS_SIZE

Const FLOAT

Const LINEAR

Const LINEAR_MIPMAP_LINEAR

Const LINEAR_MIPMAP_NEAREST

Const M_WIDTHS

Const NEAREST

Const NEAREST_MIPMAP_LINEAR

Const NEAREST_MIPMAP_NEAREST

Const REPEAT

Const RGB

Const SPACE_ID

Const TAB_ID

Const UNIFORM_1F

Const UNIFORM_1I

Const UNIFORM_2F

Const UNIFORM_3F

Const UNIFORM_MAT_4F

Const UNSIGNED_BYTE

Const X_HEIGHTS

Const fillFragShader

Const fullscreenVertShader

Const newline

Const newlineChar

Const texFragShader

Const whitespace

Functions

activeTexture

Parameters

gl: WebGLRenderingContext

texture: WebGLTexture

uniformLocation: WebGLUniformLocation

Default value textureNum: number = 0

Returns void

addKeyword

Parameters

sources: string

keywords: string | null

Returns string

addLineNumbers

Parameters

text: string

Returns string

bindBuffer

Parameters

gl: WebGLRenderingContext

buffer: WebGLBuffer

Default value location: number = 0

Default value size: number = 1

Default value type: number = FLOAT

Default value normalized: boolean = false

Default value stride: number = 0

Default value offset: number = 0

Default value isBind: boolean = true

Returns void

calculateCircleCenter

Parameters