Class: ShaderCombiner

Extends

• Shader

Methods

---

addFilter(filter)

Adds a filter to the shader pipeline.

Parameters:

Name	Type	Description
filter	Object	Filter to add

Inherited From:

• Shader#addFilter

Overrides:

• Shader#addFilter

Source:

• Shader.js, line 78

Fires:

• Shader#event:update

---

allUniforms()

Returns all uniform variables associated with the shader and its filters. Combines uniforms from both the base shader and all active filters into a single object.

Inherited From:

• Shader#allUniforms

Overrides:

• Shader#allUniforms

Source:

• Shader.js, line 294

Returns:

Combined uniform variables

Type

Object.<string, Object>

---

clearFilters()

Clears all filters from the shader pipeline.

Inherited From:

• Shader#clearFilters

Overrides:

• Shader#clearFilters

Source:

• Shader.js, line 67

Fires:

• Shader#event:update

---

getUniform(name)

Gets a uniform variable by name. Searches both shader uniforms and filter uniforms.

Parameters:

Name	Type	Description
name	string	Uniform variable name

Inherited From:

• Shader#getUniform

Overrides:

• Shader#getUniform

Source:

• Shader.js, line 279

Returns:

Uniform object if found

Type

Object | undefined

---

removeFilter(name)

Removes a filter from the pipeline by name.

Parameters:

Name	Type	Description
name	string	Name of filter to remove

Inherited From:

• Shader#removeFilter

Overrides:

• Shader#removeFilter

Source:

• Shader.js, line 91

Fires:

• Shader#event:update

---

setMode(mode)

Sets the current shader mode.

Parameters:

Name	Type	Description
mode	string	Mode identifier (must be in options.modes)

Inherited From:

• Shader#setMode

Overrides:

• Shader#setMode

Source:

• Shader.js, line 104

Throws:

If mode is not recognized

Type

Error

---

setTileSize(size)

Sets tile dimensions for shader calculations.

Parameters:

Name	Type	Description
size	Array.<number>	[width, height] of tile

Inherited From:

• Shader#setTileSize

Overrides:

• Shader#setTileSize

Source:

• Shader.js, line 124

---

setUniform(name, value)

Sets a uniform variable value.

Parameters:

Name	Type	Description
name	string	Uniform variable name
value	number | boolean | Array	Value to set

Inherited From:

• Shader#setUniform

Overrides:

• Shader#setUniform

Source:

• Shader.js, line 136

Fires:

• Shader#event:update

Throws:

If uniform doesn't exist

Type

Error

Type Definitions

---

Operation

A shader operation that combines two textures.

Type:

• Object

Properties:

Name	Type	Description
first	string	Assigns first texture as output (cout = c1)
second	string	Assigns second texture as output (cout = c2)
mean	string	Calculates average of textures (cout = (c1 + c2)/2.0)
diff	string	Calculates difference between textures (cout = c2.rgb - c1.rgb)

Source:

• ShaderCombiner.js, line 3

Events

---

update

Fired when shader combination mode changes.

Type: Object

Properties:

Name	Type	Description
mode	string	New combination mode
previousMode	string	Previous combination mode

Overrides:

• Shader#event:update

Source:

• ShaderCombiner.js, line 12