Class: Shader

Constructor

new Shader(vertexFunc, fragmentFunc, shaderInitFunc)

(DO NOT USE) Internal use by Hummingbird only.

Parameters:

Name	Type	Description
`vertexFunc`	function	Optional function that returns the vertex shader source, defaults.
`fragmentFunc`	function	Optional function that returns the fragment shader source, defaults.
`shaderInitFunc`	function	Optional function to (for example) initialize uniforms in the shader, defaults.

Source: shader.js, line 17

Members

(readonly) attribLocationCache

(DO NOT USE) Internal variable for caching shader attributes, to minimize API calls.

Source: shader.js, line 53

(readonly) fragmentSource

(DO NOT USE) Internal variable to keep track of the fragment source for compilation.

Source: shader.js, line 37

(readonly) id

(DO NOT USE) Internal variable in which the shader is stored.

Source: shader.js, line 48

(readonly) initFunc

(DO NOT USE) Internal variable for initilization of parts of the shaders (like uniforms).

Source: shader.js, line 42

(readonly) uniformLocationCache

(DO NOT USE) Internal variable for caching shader uniforms, to minimize API calls.

Source: shader.js, line 58

(readonly) vertexSource

(DO NOT USE) Internal variable to keep track of the vertex source for compilation.

Source: shader.js, line 32

Methods

bind()

(DO NOT USE) Method to bind this shader program (set it as active).

Source: shader.js, line 166

compileShader(type, source) → {WebGLShader}

(DO NOT USE) Method for compiling shaders.

Parameters:

Name	Type	Description
`type`	number	The type of shader, see MDN.
`source`	string	Shader source to use.

Source: shader.js, line 102

Returns:

Type:: WebGLShader

createProgram(vertexShaderSource, fragmentShaderSource) → {WebGLProgram}

(DO NOT USE) Actual method for creating the shader program with compiled shaders.

Parameters:

Name	Type	Description
`vertexShaderSource`	string	Argument for vertex shader to use.
`fragmentShaderSource`	string	Argument for fragment shader to use.

Source: shader.js, line 79

Returns:

Type:: WebGLProgram

delete()

(DO NOT USE) Method to unbind and then delete this shader program, is called from HB.Renderer#delete.

Source: shader.js, line 176

getAttribLocation(name) → {number}

(DO NOT USE) Method for getting the location of attributes inside shaders.

Parameters:

Name	Type	Description
`name`	string	Name of the attribute.

Source: shader.js, line 122

Returns:

ID of attribute inside shader.

Type:: number

getUniformLocation(name) → {WebGLUniformLocation}

(DO NOT USE) Method for getting the location of uniforms inside shaders.

Parameters:

Name	Type	Description
`name`	string	Name of the uniform.

Source: shader.js, line 132

Returns:

Location of uniform inside shader.

Type:: WebGLUniformLocation

setUniform(type, name, values)

(DO NOT USE) Method for setting a uniform inside shaders.

Parameters:

Name	Type	Description
`type`	string	Type of value, "f" for floats and "i" for integers, see MDN.
`name`	string	Name of the uniform.
`values`	Array	Array with values, length 1-4, see MDN.

Source: shader.js, line 143

setUniformArray(type, name, array, elementAmount)

(DO NOT USE) Method for setting array uniforms inside shaders.

Parameters:

Name	Type	Default	Description
`type`	string		Type of value, "f" for floats and "i" for integers, see MDN.
`name`	string		Name of the uniform.
`array`	Array		Array with values, see MDN.
`elementAmount`	number	1	Amount of elements in each element of the array, i.e. 2 for vec2, see docs.gl and MDN.

Source: shader.js, line 152

setUniformMatrix(type, name, matrix)

(DO NOT USE) Method for setting matrix uniforms inside shaders.

Parameters:

Name	Type	Description
`type`	string	Type of value, "f" for floats only, see MDN.
`name`	string	Name of the uniform.
`matrix`	glMatrix.mat4	Matrix.

Source: shader.js, line 160

unbind()

(DO NOT USE) Method to bind an empty shader program (set this one as inactive).

Source: shader.js, line 171

(static) init()

(DO NOT USE) Internal method for creating the HB.shader instance.

Source: shader.js, line 65