openglobus

Class: Handler

og/webgl/Handler~Handler

new Handler(id, params)

og/webgl/Handler.js, line 36
A WebGL handler for accessing low-level WebGL capabilities.
Name Type Description
id string Canvas element id that WebGL handler assing with. If it's null or undefined creates hidden canvas and handler bacomes hidden.
params Object optional Handler options:
Name Type Description
anisotropy number optional Anisitropy filter degree. 8 is default.
width number optional Hidden handler width. 256 is default.
height number optional Hidden handler height. 256 is default.
param.scontext Object optional Native WebGL context attributes. See https://www.khronos.org/registry/webgl/specs/latest/1.0/#WEBGLCONTEXTATTRIBUTES
params.extensions Array.<string> optional Additional WebGL extension list. Available by default: OES_standard_derivatives, EXT_texture_filter_anisotropic.

Members

protected_clocks

Custom timers.

activeShaderProgramog.webgl.ShaderController

Current active shader program controller.

canvasObject

WebGL rendering canvas element.

defaultClockog.Clock

Application default timer.

readonlydeltaTimenumber

Draw frame time in milliseconds.

extensionsObject

Current WebGL extensions. Becomes here after context initialization.

glObject

WebGL context.

shaderProgramsObject.<og.webgl.ShaderController>

Shader program controller list.

Methods

staticmodule:og/webgl/Handler~Handler.getContext(canvas){Object}

og/webgl/Handler.js, line 167
Returns a drawing context on the canvas, or null if the context identifier is not supported.
Name Type Description
canvas Object HTML canvas object.
Returns:
Type Description
Object

staticmodule:og/webgl/Handler~Handler.getExtension(gl, name){Object}

og/webgl/Handler.js, line 150
The return value is null if the extension is not supported, or an extension object otherwise.
Name Type Description
gl Object WebGl context pointer.
name String Extension name.
Returns:
Type Description
Object -

activateBlending()

og/webgl/Handler.js, line 600
Activate blending.

activateDepthTest()

og/webgl/Handler.js, line 568
Activate depth test.

activateFaceCulling()

og/webgl/Handler.js, line 584
Activate face culling.

addShaderProgram(program, notActivate)

og/webgl/Handler.js, line 427
Adds shader program to the handler.
Name Type Description
program og.webgl.ShaderProgram Shader program.
notActivate boolean optional If it's true program will not compile.

addShaderPrograms(programsArr)

og/webgl/Handler.js, line 454
Adds shader programs to the handler.
Name Type Description
programsArr Array.<og.webgl.ShaderProgram> Shader program array.

clearFrame()

og/webgl/Handler.js, line 749
Clearing gl frame.

createArrayBuffer(array, itemSize, numItems, usage){Object}

og/webgl/Handler.js, line 621
Creates ARRAY buffer.
Name Type Default Description
array Array.<number> Input array.
itemSize number Array item size.
numItems number Items quantity.
usage number STATIC_DRAW optional Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
Returns:
Type Description
Object -

createDefaultTexture(params)

og/webgl/Handler.js, line 790
Name Type Description
params

createElementArrayBuffer(array, itemSize, numItems, usage){Object}

og/webgl/Handler.js, line 643
Creates ELEMENT ARRAY buffer.
Name Type Default Description
array Array.<number> Input array.
itemSize number Array item size.
numItems number Items quantity.
usage number STATIC_DRAW optional Parameter of the bufferData call can be one of STATIC_DRAW, DYNAMIC_DRAW, or STREAM_DRAW.
Returns:
Type Description
Object -

createEmptyTexture_f(width, height){Object}

og/webgl/Handler.js, line 240
Creates Empty float texture.
Name Type Description
width number Empty texture width.
height number Empty texture height.
Returns:
Type Description
Object - WebGL float texture object.

createEmptyTexture_hf(width, height){Object}

og/webgl/Handler.js, line 219
Creates Empty half float texture.
Name Type Description
width number Empty texture width.
height number Empty texture height.
Returns:
Type Description
Object - WebGL half float texture object.

createEmptyTexture_l(width, height){Object}

og/webgl/Handler.js, line 282
Creates empty LINEAR filtered texture.
Name Type Description
width number Empty texture width.
height number Empty texture height.
Returns:
Type Description
Object - WebGL texture object.

createEmptyTexture_n(width, height){Object}

og/webgl/Handler.js, line 261
Creates Empty NEAREST filtered texture.
Name Type Description
width number Empty texture width.
height number Empty texture height.
Returns:
Type Description
Object - WebGL texture object.

createTexture(image){Object}

og/webgl/Handler.js, line 362
Creates DEFAULT filter texture, ANISOTROPY is default.
Name Type Description
image Object Image or Canvas object.
Returns:
Type Description
Object - WebGL texture object.

createTexture_a(image){Object}

og/webgl/Handler.js, line 341
Creates ANISOTROPY filter texture.
Name Type Description
image Object Image or Canvas object.
Returns:
Type Description
Object - WebGL texture object.

createTexture_l(image){Object}

og/webgl/Handler.js, line 302
Creates LINEAR filter texture.
Name Type Description
image Object Image or Canvas object.
Returns:
Type Description
Object - WebGL texture object.

createTexture_mm(image){Object}

og/webgl/Handler.js, line 321
Creates MIPMAP filter texture.
Name Type Description
image Object Image or Canvas object.
Returns:
Type Description
Object - WebGL texture object.

createTexture_n(image){Object}

og/webgl/Handler.js, line 198
Creates NEAREST filter texture.
Name Type Description
image Object Image or Canvas object.
Returns:
Type Description
Object - WebGL texture object.

deactivateBlending()

og/webgl/Handler.js, line 608
Deactivate blending.

deactivateDepthTest()

og/webgl/Handler.js, line 576
Deactivate depth test.

deactivateFaceCulling()

og/webgl/Handler.js, line 592
Deactivate face cullting.

destroy()

og/webgl/Handler.js, line 820

drawFrame(now)

og/webgl/Handler.js, line 721
Draw single frame.
Name Type Description
now number Frame current time milliseconds.

getCenter(){number}

og/webgl/Handler.js, line 711
Returns screen center coordinates.
Returns:
Type Description
number

getClientAspect(){number}

og/webgl/Handler.js, line 702
Returns canvas aspect ratio.
Returns:
Type Description
number

getHeight(){number}

og/webgl/Handler.js, line 693
Returns context screen height.
Returns:
Type Description
number

getWidth(){number}

og/webgl/Handler.js, line 684
Returns context screen width.
Returns:
Type Description
number

initialize()

og/webgl/Handler.js, line 510
Main function that initialize handler.

initializeExtension(extensionStr)

og/webgl/Handler.js, line 494
Initialize additional WebGL extensions.
Name Type Description
extensionStr string Extension name.

loadCubeMapTexture(params){Object}

og/webgl/Handler.js, line 378
Creates cube texture.
Name Type Description
params Object.<string> Face image urls:
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.
Returns:
Type Description
Object - WebGL texture object.

removeShaderProgram(program)

og/webgl/Handler.js, line 445
Removes shader program from handler.
Name Type Description
program String Shader program name.

setFrameCallback(callback)

og/webgl/Handler.js, line 188
Sets animation frame function.
Name Type Description
callback callback Frame callback.

setSize(width, height)

og/webgl/Handler.js, line 659
Sets handler canvas size.
Name Type Description
width number Canvas width.
height number Canvas height.

start()

og/webgl/Handler.js, line 759
Starts animation loop.