Class: Handler

Constructor

new Handler(canvasTarget, paramsopt)

Parameters:

Name Type Attributes Description

canvasTarget

string | HTMLCanvasElement

Canvas element target. or undefined creates hidden canvas and handler becomes hidden.

params

Object

Handler options:

Properties

Name	Type	Attributes	Description
`anisotropy`	number	<optional>	Anisotropy filter degree. 8 is default.
`width`	number	<optional>	Hidden handler width. 256 is default.
`height`	number	<optional>	Hidden handler height. 256 is default.
`extensions`	Array.<string>	<optional>	Additional WebGL extension list. Available by default: EXT_texture_filter_anisotropic.

Source: webgl/Handler.ts, line 54

Methods

(protected) _animationFrameCallback()

Make animation.

Source: webgl/Handler.ts, line 1220

(protected) _initProgramController(sc)

Used in addProgram

Parameters:

Name	Type	Description
`sc`	ProgramController	Program controller

Source: webgl/Handler.ts, line 806

(protected) _setDefaults()

Sets default gl render parameters. Used in init function.

Source: webgl/Handler.ts, line 948

addProgram(program, notActivateopt) → {Program}

Adds shader program to the handler.

Parameters:

Name	Type	Attributes	Default	Description
`program`	Program			Shader program.
`notActivate`	boolean	<optional>	false	If it's true program will not compile.

Source: webgl/Handler.ts, line 765

Returns:

Type:: Program

addPrograms(programsArr)

Adds shader programs to the handler.

Parameters:

Name	Type	Description
`programsArr`	Array.<Program>	Shader program array.

Source: webgl/Handler.ts, line 795

clearFrame()

Clearing gl frame.

Source: webgl/Handler.ts, line 1181

createArrayBuffer(array, itemSize, numItems, usageopt) → {WebGLBufferExt}

Creates ARRAY buffer.

Parameters:

Name	Type	Attributes	Default	Description
`array`	TypedArray			Input array.
`itemSize`	number			Array item size.
`numItems`	number			Items quantity.
`usage`	number	<optional>	STATIC_DRAW	Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.

Source: webgl/Handler.ts, line 1021

Returns:

Type:: WebGLBufferExt

createArrayBufferLength(size, usageopt) → {WebGLBufferExt}

Creates ARRAY buffer specific length.

Parameters:

Name	Type	Attributes	Default	Description
`size`	number
`usage`	number	<optional>	STATIC_DRAW	Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.

Source: webgl/Handler.ts, line 1041

Returns:

Type:: WebGLBufferExt

createDefaultTexture(params, success)

Creates default texture object

Parameters:

Name	Type	Description
`params`	IDefaultTextureParams \| null	Texture parameters:
`success`

Source: webgl/Handler.ts, line 1231

createElementArrayBuffer(array, itemSize, numItems, usageopt) → {Object}

Creates ELEMENT ARRAY buffer.

Parameters:

Name	Type	Attributes	Default	Description
`array`	TypedArray			Input array.
`itemSize`	number			Array item size.
`numItems`	number			Items quantity.
`usage`	number	<optional>	STATIC_DRAW	Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.

Source: webgl/Handler.ts, line 1059

Returns:

Type:: Object

createEmptyTexture2DExt(widthopt, heightopt, filteropt, internalFormatopt, formatopt, typeopt, levelopt) → {WebGLTexture|null}

Creates empty texture.

Parameters:

Name	Type	Attributes	Default	Description
`width`	number	<optional>	1	Specifies the width of the texture image.
`height`	number	<optional>	1	Specifies the width of the texture image.
`filter`	string	<optional>	"NEAREST"	Specifies GL_TEXTURE_MIN(MAX)_FILTER texture value.
`internalFormat`	string	<optional>	"RGBA"	Specifies the color components in the texture.
`format`	string	<optional>	"RGBA"	Specifies the format of the texel data.
`type`	string	<optional>	"UNSIGNED_BYTE"	Specifies the data type of the texel data.
`level`	number	<optional>	0	Specifies the level-of-detail number. Level 0 is the base image level. Level n is the nth mipmap reduction image.

Source: webgl/Handler.ts, line 359

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createEmptyTexture_l(width, height, internalFormatopt) → {WebGLTexture|null}

Creates empty LINEAR filtered texture.

Parameters:

Name	Type	Attributes	Description
`width`	number		Empty texture width.
`height`	number		Empty texture height.
`internalFormat`	number	<optional>

Source: webgl/Handler.ts, line 444

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createEmptyTexture_n(width, height, internalFormatopt) → {WebGLTexture|null}

Creates Empty NEAREST filtered texture.

Parameters:

Name	Type	Attributes	Description
`width`	number		Empty texture width.
`height`	number		Empty texture height.
`internalFormat`	number	<optional>

Source: webgl/Handler.ts, line 406

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createStreamArrayBuffer(itemSize, numItems, usageopt, bytesopt) → {WebGLBufferExt}

Creates STREAM_DRAW ARRAY buffer.

Parameters:

Name	Type	Attributes	Default	Description
`itemSize`	number			Array item size.
`numItems`	number			Items quantity.
`usage`	number	<optional>	STATIC_DRAW	Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
`bytes`	number	<optional>	4

Source: webgl/Handler.ts, line 981

Returns:

Type:: WebGLBufferExt

createTexture_a_webgl1(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates ANISOTROPY filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 673

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_a_webgl2(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates ANISOTROPY filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 673

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_l_webgl1(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates LINEAR filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 614

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_l_webgl2(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates LINEAR filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 614

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_mm_webgl1(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates MIPMAP filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 644

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_mm_webgl2(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates MIPMAP filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 644

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_n_webgl1(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates NEAREST filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	HTMLCanvasElement \| Image			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 472

Returns:

WebGL texture object.

Type:: WebGLTexture | null

createTexture_n_webgl2(image, internalFormatopt, textureopt) → {WebGLTexture|null}

Creates NEAREST filter texture.

Parameters:

Name	Type	Attributes	Default	Description
`image`	ImageSource			Image or Canvas object.
`internalFormat`	number	<optional>
`texture`	WebGLTexture \| null	<optional>	null

Source: webgl/Handler.ts, line 584

Returns:

WebGL texture object.

Type:: WebGLTexture | null

destroy()

Source: webgl/Handler.ts, line 1272

getCenter() → {number}

Returns canvas center coordinates.

Source: webgl/Handler.ts, line 1139

Returns:

Type:: number

getClientAspect() → {number}

Returns canvas aspect ratio.

Source: webgl/Handler.ts, line 1130

Returns:

Type:: number

getHeight() → {number}

Returns context screen height.

Source: webgl/Handler.ts, line 1121

Returns:

Type:: number

getWidth() → {number}

Returns context screen width.

Source: webgl/Handler.ts, line 1112

Returns:

Type:: number

initialize()

Main function that initialize handler.

Source: webgl/Handler.ts, line 856

initializeExtension(extensionStr, showLog) → {any}

Initialize additional WebGL extensions.

Parameters:

Name	Type	Default	Description
`extensionStr`	string		Extension name.
`showLog`	boolean	false	Show logging.

Source: webgl/Handler.ts, line 835

Returns:

Type:: any

isWebGl2()

Check is gl context type equals webgl2

Source: webgl/Handler.ts, line 1212

loadCubeMapTexture(params) → {WebGLTexture|null}

Creates cube texture.

Parameters:

Name Type Description

params

Texture3DParams

Face image urls:

Properties

Name	Type	Description
`px`	string	Positive X or right image url.
`nx`	string	Negative X or left image url.
`py`	string	Positive Y or up image url.
`ny`	string	Negative Y or bottom image url.
`pz`	string	Positive Z or face image url.
`nz`	string	Negative Z or back image url.

Source: webgl/Handler.ts, line 703

Returns:

WebGL texture object.

Type:: WebGLTexture | null

removeProgram(name)

Removes shader program from handler.

Parameters:

Name	Type	Description
`name`	string	Shader program name.

Source: webgl/Handler.ts, line 786

setFrameCallback(callback)

Sets animation frame function.

Parameters:

Name	Type	Description
`callback`	function	Frame callback.

Source: webgl/Handler.ts, line 350

setSize(w, h)

Sets handler canvas size.

Parameters:

Name	Type	Description
`w`	number	Canvas width.
`h`	number	Canvas height.

Source: webgl/Handler.ts, line 1079

setStreamArrayBuffer(buffer, array, offsetopt) → {WebGLBufferExt}

Sets stream buffer.

Parameters:

Name	Type	Attributes	Default
`buffer`	WebGLBufferExt
`array`	TypedArray
`offset`	number	<optional>	0

Source: webgl/Handler.ts, line 1005

Returns:

Type:: WebGLBufferExt

start()

Starts animation loop.

Source: webgl/Handler.ts, line 1191

(static) getContext(canvas, contextAttributesopt) → {WebGLContextExt|null}

Returns a drawing context on the canvas, or null if the context identifier is not supported.

Parameters:

Name	Type	Attributes	Description
`canvas`	HTMLCanvasElement		HTML canvas object.
`contextAttributes`	any	<optional>	See canvas.getContext contextAttributes.

Source: webgl/Handler.ts, line 313

Returns:

Type:: WebGLContextExt | null

(static) getExtension(gl, name) → {any}

The return value is null if the extension is not supported, or an extension object otherwise.

Parameters:

Name	Type	Description
`gl`	WebGLRenderingContext \| WebGL2RenderingContext \| null	WebGl context pointer.
`name`	string	Extension name.

Source: webgl/Handler.ts, line 294

Returns:

Type:: any