Class: BasicTextureProgram

BasicTextureProgram(gl)

BasicTextureProgram is a GLSL program that draws textured or untextured geometry.

Constructor

new BasicTextureProgram(gl)

Constructs a new program. Initializes, compiles and links this GLSL program with the source code for its vertex and fragment shaders.

This method creates WebGL shaders for the program's shader sources and attaches them to a new GLSL program. This method then compiles the shaders and then links the program if compilation is successful. Use the bind method to make the program current during rendering.

Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
Source:
Throws:
If the shaders cannot be compiled, or if linking of the compiled shaders into a program fails.
Type
ArgumentError

Extends

Members

(static, readonly) key :string

A string that uniquely identifies this program.
Type:
  • string
Source:

(readonly) applyLightingLocation :WebGLUniformLocation

The WegGL location for this program's 'enableLighting' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) colorLocation :WebGLUniformLocation

The WebGL location for this program's 'color' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) modulateColorLocation :WebGLUniformLocation

The WebGL location for this program's 'modulateColor' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) mvInverseMatrixLocation :WebGLUniformLocation

The WebGL location for this program's 'mvInverseMatrix' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) mvpMatrixLocation :WebGLUniformLocation

The WebGL location for this program's 'mvpMatrix' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) normalVectorLocation :Number

The WebGL location for this program's 'normalVector' attribute.
Type:
  • Number
Source:

(readonly) opacityLocation :WebGLUniformLocation

The WebGL location for this program's 'opacity' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) programId :WebGLProgram

Indicates the WebGL program object associated with this GPU program.
Type:
  • WebGLProgram
Inherited From:
Source:

(readonly) textureEnabledLocation :WebGLUniformLocation

The WebGL location for this program's 'enableTexture' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) textureMatrixLocation :WebGLUniformLocation

The WebGL location for this program's 'texCoordMatrix' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) textureUnitLocation :WebGLUniformLocation

The WebGL location for this program's 'textureSampler' uniform.
Type:
  • WebGLUniformLocation
Source:

(readonly) vertexPointLocation :Number

The WebGL location for this program's 'vertexPoint' attribute.
Type:
  • Number
Source:

(readonly) vertexTexCoordLocation :Number

The WebGL location for this program's 'vertexTexCoord' attribute.
Type:
  • Number
Source:

Methods

attributeLocation(gl, attributeName) → {Number}

Returns the GLSL attribute location of a specified attribute name.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
attributeName String The name of the attribute whose location is determined.
Inherited From:
Source:
Throws:
If the specified attribute name is null, empty or undefined.
Type
ArgumentError
Returns:
The WebGL attribute location of the specified attribute, or -1 if the attribute is not found.
Type
Number

dispose(gl)

Releases this GPU program's WebGL program and associated shaders. Upon return this GPU program's WebGL program ID is 0 as is that of the associated shaders.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
Inherited From:
Source:
Links a specified GLSL program. This method is not meant to be called by applications. It is called internally as needed.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
program WebGLProgram The WebGL program.
Inherited From:
Source:
Returns:
true if linking was successful, otherwise false.
Type
Boolean

loadApplyLighting(gl, applyLighting)

Loads the specified boolean as the value of this program's 'applyLighting' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
applyLighting Number true to apply lighting, otherwise false.
Source:

loadColor(gl, color)

Loads the specified color as the value of this program's 'color' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
color Color The color to load.
Source:
Throws:
If the specified color is null or undefined.
Type
ArgumentError

loadModelviewInverse(gl, matrix)

Loads the specified matrix as the value of this program's 'mvInverseMatrix' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
matrix Matrix The matrix to load.
Source:
Throws:
If the specified matrix is null or undefined.
Type
ArgumentError

loadModelviewProjection(gl, matrix)

Loads the specified matrix as the value of this program's 'mvpMatrix' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
matrix Matrix The matrix to load.
Source:
Throws:
If the specified matrix is null or undefined.
Type
ArgumentError

loadModulateColor(gl, enable)

Loads the specified boolean as the value of this program's 'modulateColor' uniform variable. When this value is true and the value of the textureEnabled variable is true, the color uniform of this shader is multiplied by the rounded alpha component of the texture color at each fragment. This causes the color to be either fully opaque or fully transparent depending on the value of the texture color's alpha value. This is used during picking to replace opaque or mostly opaque texture colors with the pick color, and to make all other texture colors transparent.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
enable Boolean true to enable modulation, false to disable modulation.
Source:

loadOpacity(gl, opacity)

Loads the specified number as the value of this program's 'opacity' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
opacity Number The opacity in the range [0, 1].
Source:

loadTextureEnabled(gl, enable)

Loads the specified boolean as the value of this program's 'enableTexture' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
enable Boolean true to enable texturing, false to disable texturing.
Source:

loadTextureMatrix(gl, matrix)

Loads the specified matrix as the value of this program's 'texCoordMatrix' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
matrix Matrix The texture coordinate matrix.
Source:

loadTextureUnit(gl, unit)

Loads the specified number as the value of this program's 'textureSampler' uniform variable.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
unit Number The texture unit.
Source:

loadUniformColor(gl, color, location)

Loads a specified color as the value of a GLSL vec4 uniform variable with the specified location.

This function multiplies the red, green and blue components by the alpha component prior to loading the color in the GLSL uniform variable, but does not modify the specified color.

Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
color Color The color to load.
location WebGLUniformLocation The location of the uniform variable in the currently bound GLSL program.
Inherited From:
Source:
Throws:
If the specified color is null or undefined.
Type
ArgumentError

loadUniformColorComponents(gl, red, green, blue, alpha, location)

Loads the specified RGBA color components as the value of a GLSL vec4 uniform variable with the specified location.

This function multiplies the red, green and blue components by the alpha component prior to loading the color in the GLSL uniform variable.

Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
red Number The red component, a number between 0 and 1.
green Number The green component, a number between 0 and 1.
blue Number The blue component, a number between 0 and 1.
alpha Number The alpha component, a number between 0 and 1.
location WebGLUniformLocation The location of the uniform variable in the currently bound GLSL program.
Inherited From:
Source:

loadUniformMatrix(gl, matrix, location)

Loads a specified matrix as the value of a GLSL 4x4 matrix uniform variable with the specified location.

This functions converts the matrix into column-major order prior to loading its components into the GLSL uniform variable, but does not modify the specified matrix.

Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
matrix Matrix The matrix to load.
location WebGLUniformLocation The location of the uniform variable in the currently bound GLSL program.
Inherited From:
Source:
Throws:
If the specified matrix is null or undefined.
Type
ArgumentError

uniformLocation(gl, uniformName) → {WebGLUniformLocation}

Returns the GLSL uniform location of a specified uniform name.
Parameters:
Name Type Description
gl WebGLRenderingContext The current WebGL context.
uniformName String The name of the uniform variable whose location is determined.
Inherited From:
Source:
Throws:
If the specified uniform name is null, empty or undefined.
Type
ArgumentError
Returns:
The WebGL uniform location of the specified uniform variable, or -1 if the uniform is not found.
Type
WebGLUniformLocation