Class ShaderMaterial

Hierarchy (view full)

ShareableContextConsumer
- ShaderMaterial
  - HTMLScriptsMaterial
  - LineMaterial

Implements

Material

Constructors

constructor

new ShaderMaterial(vertexShaderSrc, fragmentShaderSrc, attribs, contextManager, levelUp?): ShaderMaterial
1. Creates a subscription to WebGL rendering context events but does not synchronize.
2. Constructs vertex and fragment shader sources.
3. Synchronizes with the WebGL rendering context if this is a top-level class (levelUp is zero).
The contextManager must be defined.
Parameters
- vertexShaderSrc: string
  The vertex shader source code.
- fragmentShaderSrc: string
  The fragment shader source code.
- attribs: string[]
  The attribute ordering.
- contextManager: ContextManager
  The ContextManager to subscribe to for WebGL rendering context events.
- levelUp: number = 0
  The level of this class in the implementation inheritance hierarchy.
Returns ShaderMaterial
Overrides ShareableContextConsumer.constructor
- Defined in src/lib/materials/ShaderMaterial.ts:67

Properties

`Protected`contextManager

contextManager: ContextManager

The ContextManager that will be subscribed to for WebGL rendering context events.

Accessors

attributeNames

get attributeNames(): string[]
Returns string[]
- Defined in src/lib/materials/ShaderMaterial.ts:217
set attributeNames(unused): void
Parameters
- unused: string[]
Returns void
- Defined in src/lib/materials/ShaderMaterial.ts:226

fragmentShaderSrc

get fragmentShaderSrc(): string
Returns string
- Defined in src/lib/materials/ShaderMaterial.ts:210

gl

get gl(): WebGLRenderingContext
Provides access to the underlying WebGL context.

Returns WebGLRenderingContext
Inherited from ShareableContextConsumer.gl
- Defined in src/lib/core/ShareableContextConsumer.ts:116

vertexShaderSrc

get vertexShaderSrc(): string
Returns string
- Defined in src/lib/materials/ShaderMaterial.ts:203

Methods

activeTexture

activeTexture(texture): void
Informs the facet visitor of which texture unit is to be used.
Parameters
- texture: TextureUnit
Returns void
Implementation of Material.activeTexture
- Defined in src/lib/materials/ShaderMaterial.ts:352

addRef

addRef(): number
Notifies this instance that something is referencing it.
Returns number
The new value of the reference count.
Implementation of Material.addRef
Inherited from ShareableContextConsumer.addRef
- Defined in src/lib/core/ShareableBase.ts:110

attrib

attrib(name, value, size, normalized?, stride?, offset?): Material
Parameters
- name: string
- value: VertexBuffer
- size: number
- normalized: boolean = false
- stride: number = 0
- offset: number = 0
Returns Material
Implementation of Material.attrib
- Defined in src/lib/materials/ShaderMaterial.ts:294

cleanUp

cleanUp(): void
Returns void
Inherited from ShareableContextConsumer.cleanUp
- Defined in src/lib/core/ShareableContextConsumer.ts:89

contextFree

contextFree(): void
Returns void
Implementation of Material.contextFree
Overrides ShareableContextConsumer.contextFree
- Defined in src/lib/materials/ShaderMaterial.ts:170

contextGain

contextGain(): void
Returns void
Implementation of Material.contextGain
Overrides ShareableContextConsumer.contextGain
- Defined in src/lib/materials/ShaderMaterial.ts:107

contextLost

contextLost(): void
Returns void
Implementation of Material.contextLost
Overrides ShareableContextConsumer.contextLost
- Defined in src/lib/materials/ShaderMaterial.ts:149

`Protected`destructor

destructor(levelUp): void
Parameters
- levelUp: number
Returns void
Overrides ShareableContextConsumer.destructor
- Defined in src/lib/materials/ShaderMaterial.ts:96

disableAttrib

disableAttrib(indexOrName): void
Parameters
- indexOrName: string | number
Returns void
Implementation of Material.disableAttrib
- Defined in src/lib/materials/ShaderMaterial.ts:265

disableAttribs

disableAttribs(): void
Returns void
- Defined in src/lib/materials/ShaderMaterial.ts:283

drawArrays

drawArrays(mode, first, count): Material
Parameters
- mode: BeginMode
  Specifies the type of the primitive being rendered.
- first: number
  Specifies the starting index in the array of vector points.
- count: number
  The number of points to be rendered.
Returns Material
Implementation of Material.drawArrays
- Defined in src/lib/materials/ShaderMaterial.ts:541

drawElements

drawElements(mode, count, type, offset): Material
Parameters
- mode: BeginMode
  Specifies the type of the primitive being rendered.
- count: number
  The number of elements to be rendered.
- type: DataType
  The type of the values in the element array buffer.
- offset: number
  Specifies an offset into the element array buffer.
Returns Material
Implementation of Material.drawElements
- Defined in src/lib/materials/ShaderMaterial.ts:555

enableAttrib

enableAttrib(indexOrName): void
Convenience method for dereferencing the name to an attribute location, followed by enabling the attribute.
Parameters
- indexOrName: string | number
Returns void
Implementation of Material.enableAttrib
- Defined in src/lib/materials/ShaderMaterial.ts:233

enableAttribs

enableAttribs(): void
Returns void
- Defined in src/lib/materials/ShaderMaterial.ts:251

getAttrib

getAttrib(indexOrName): Attrib
Parameters
- indexOrName: string | number
Returns Attrib
Implementation of Material.getAttrib
- Defined in src/lib/materials/ShaderMaterial.ts:304

getAttribLocation

getAttribLocation(name): number
Returns the location (index) of the attribute with the specified name. Returns -1 if the name does not correspond to an attribute.
Parameters
- name: string
Returns number
Implementation of Material.getAttribLocation
- Defined in src/lib/materials/ShaderMaterial.ts:319

getLoggingName

getLoggingName(): string
Returns the name that was assigned by the call to the setLoggingName method.

Returns string
Inherited from ShareableContextConsumer.getLoggingName
- Defined in src/lib/core/ShareableBase.ts:124

getUniform

getUniform(name): Uniform
Returns a Uniform object corresponding to the uniform parameter of the same name in the shader code. If a uniform parameter of the specified name does not exist, this method returns undefined (void 0).
Parameters
- name: string
Returns Uniform
Implementation of Material.getUniform
- Defined in src/lib/materials/ShaderMaterial.ts:333

hasUniform

hasUniform(name): boolean
Determines whether a uniform with the specified name exists in the WebGLProgram.
Parameters
- name: string
Returns boolean
Implementation of Material.hasUniform
- Defined in src/lib/materials/ShaderMaterial.ts:347

isZombie

isZombie(): boolean
An object is a zombie if it has been released by all who have held references. In some cases it may be possible to recycle a zombie.

Returns boolean
Inherited from ShareableContextConsumer.isZombie
- Defined in src/lib/core/ShareableBase.ts:99

matrix2fv

matrix2fv(name, matrix, transpose?): ShaderMaterial
Parameters
- name: string
- matrix: Float32Array
- transpose: boolean = false
Returns ShaderMaterial
Implementation of Material.matrix2fv
- Defined in src/lib/materials/ShaderMaterial.ts:512

matrix3fv

matrix3fv(name, matrix, transpose?): ShaderMaterial
Parameters
- name: string
- matrix: Float32Array
- transpose: boolean = false
Returns ShaderMaterial
Implementation of Material.matrix3fv
- Defined in src/lib/materials/ShaderMaterial.ts:520

matrix4fv

matrix4fv(name, matrix, transpose?): ShaderMaterial
Parameters
- name: string
- matrix: Float32Array
- transpose: boolean = false
Returns ShaderMaterial
Implementation of Material.matrix4fv
- Defined in src/lib/materials/ShaderMaterial.ts:528

release

release(): number
Notifies this instance that something is dereferencing it.
Returns number
The new value of the reference count.
Implementation of Material.release
Inherited from ShareableContextConsumer.release
- Defined in src/lib/core/ShareableBase.ts:157

`Protected`resurrector

resurrector(levelUp): void
Parameters
- levelUp: number
Returns void
Overrides ShareableContextConsumer.resurrector
- Defined in src/lib/materials/ShaderMaterial.ts:85

`Protected`setLoggingName

setLoggingName(name): void
This method is for use within constructors.

Immediately after a call to the super class constructor, make a call to setLoggingName. This will have the effect of refining the name used for reporting reference counts.

This method has the secondary purpose of enabling a tally of the number of classes in the constructor chain. This enables the runtime architecture to verify that destructor chains are consistent with constructor chains, which is a good practice for cleaning up resources.

Notice that this method is intentionally protected to discourage it from being called outside of the constructor.
Parameters
- name: string
  This will usually be set to the name of the class.
Returns void
Inherited from ShareableContextConsumer.setLoggingName
- Defined in src/lib/core/ShareableBase.ts:142

synchUp

synchUp(): void
Returns void
Inherited from ShareableContextConsumer.synchUp
- Defined in src/lib/core/ShareableContextConsumer.ts:82

uniform

uniform(name, value): Material
Parameters
- name: string
- value: number | number[]
Returns Material
Implementation of Material.uniform
- Defined in src/lib/materials/ShaderMaterial.ts:470

uniform1f

uniform1f(name, x): void
Parameters
- name: string
- x: number
Returns void
Implementation of Material.uniform1f
- Defined in src/lib/materials/ShaderMaterial.ts:358

uniform1fv

uniform1fv(name, data, srcOffset?, srcLength?): void
Parameters
- name: string
- data: Float32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform1fv
- Defined in src/lib/materials/ShaderMaterial.ts:365

uniform1i

uniform1i(name, x): void
Parameters
- name: string
- x: number
Returns void
Implementation of Material.uniform1i
- Defined in src/lib/materials/ShaderMaterial.ts:372

uniform1iv

uniform1iv(name, data, srcOffset?, srcLength?): void
Parameters
- name: string
- data: Int32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform1iv
- Defined in src/lib/materials/ShaderMaterial.ts:379

uniform2f

uniform2f(name, x, y): void
Parameters
- name: string
- x: number
- y: number
Returns void
Implementation of Material.uniform2f
- Defined in src/lib/materials/ShaderMaterial.ts:386

uniform2fv

uniform2fv(name, data, srcOffset?, srcLength?): void
Parameters
- name: string
- data: Float32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform2fv
- Defined in src/lib/materials/ShaderMaterial.ts:393

uniform2i

uniform2i(name, x, y): void
Parameters
- name: string
- x: number
- y: number
Returns void
Implementation of Material.uniform2i
- Defined in src/lib/materials/ShaderMaterial.ts:400

uniform2iv

uniform2iv(name, src, srcOffset?, srcLength?): void
Parameters
- name: string
- src: Int32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform2iv
- Defined in src/lib/materials/ShaderMaterial.ts:407

uniform3f

uniform3f(name, x, y, z): void
Parameters
- name: string
- x: number
- y: number
- z: number
Returns void
Implementation of Material.uniform3f
- Defined in src/lib/materials/ShaderMaterial.ts:414

uniform3fv

uniform3fv(name, data, srcOffset, srcLength): void
Parameters
- name: string
- data: Float32Array
- srcOffset: number
- srcLength: number
Returns void
Implementation of Material.uniform3fv
- Defined in src/lib/materials/ShaderMaterial.ts:421

uniform3i

uniform3i(name, x, y, z): void
Parameters
- name: string
- x: number
- y: number
- z: number
Returns void
Implementation of Material.uniform3i
- Defined in src/lib/materials/ShaderMaterial.ts:428

uniform3iv

uniform3iv(name, src, srcOffset?, srcLength?): void
Parameters
- name: string
- src: Int32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform3iv
- Defined in src/lib/materials/ShaderMaterial.ts:435

uniform4f

uniform4f(name, x, y, z, w): void
Parameters
- name: string
- x: number
- y: number
- z: number
- w: number
Returns void
Implementation of Material.uniform4f
- Defined in src/lib/materials/ShaderMaterial.ts:442

uniform4fv

uniform4fv(name, data, srcOffset?, srcLength?): void
Parameters
- name: string
- data: Float32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform4fv
- Defined in src/lib/materials/ShaderMaterial.ts:449

uniform4i

uniform4i(name, x, y, z, w): void
Parameters
- name: string
- x: number
- y: number
- z: number
- w: number
Returns void
Implementation of Material.uniform4i
- Defined in src/lib/materials/ShaderMaterial.ts:456

uniform4iv

uniform4iv(name, src, srcOffset?, srcLength?): void
Parameters
- name: string
- src: Int32Array
- OptionalsrcOffset: number
- OptionalsrcLength: number
Returns void
Implementation of Material.uniform4iv
- Defined in src/lib/materials/ShaderMaterial.ts:463

use

use(): ShaderMaterial
Returns ShaderMaterial
Implementation of Material.use
- Defined in src/lib/materials/ShaderMaterial.ts:502

Class ShaderMaterial

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ShaderMaterial

Properties

ProtectedcontextManager

Accessors

attributeNames

Returns string[]

Parameters

Returns void

fragmentShaderSrc

Returns string

gl

Returns WebGLRenderingContext

vertexShaderSrc

Returns string

Methods

activeTexture

Parameters

Returns void

addRef

Returns number

attrib

Parameters

Returns Material

cleanUp

Returns void

contextFree

Returns void

contextGain

Returns void

contextLost

Returns void

Protecteddestructor

Parameters

Returns void

disableAttrib

Parameters

Returns void

disableAttribs

Returns void

drawArrays

Parameters

Returns Material

drawElements

Parameters

Returns Material

enableAttrib

Parameters

Returns void

enableAttribs

Returns void

getAttrib

Parameters

Returns Attrib

getAttribLocation

Parameters

Returns number

getLoggingName

Returns string

getUniform

Parameters

Returns Uniform

hasUniform

Parameters

Returns boolean

isZombie

Returns boolean

matrix2fv

Parameters

Returns ShaderMaterial

`Protected`contextManager

`Protected`destructor

`Protected`resurrector

`Protected`setLoggingName