API Docs for: 0.5.5
Show:

kick.material.Material Class

Extends kick.core.ProjectAsset
Defined in: kick/material/Material.js:11
Module: kick.material

Material configuration. Stores a material configuration and a shader.

Constructor

kick.material.Material

(
  • config
)

Defined in kick/material/Material.js:11

Parameters:

  • config Object

Example:

 var material = new KICK.material.Material({
 shader: project.load(project.ENGINE_SHADER_DIFFUSE),
     uniformData:{
         mainColor:[1.0,0.0,0.9,0.5],
         mainTexture: project.load(project.ENGINE_TEXTURE_WHITE)
     }
 });

Methods

addShaderChangeListeners

(
  • listenerFn
)
deprecated

Defined in kick/material/Material.js:164

Listener is notified whenever shader is changed

Parameters:

  • listenerFn Function

bind

(
  • currentTexture
)
Number protected

Defined in kick/material/Material.js:198

Bind material uniforms

Parameters:

  • currentTexture Number

Returns:

Number:

decorateUniforms

() private

Defined in kick/material/Material.js:55

Called when a shader is set or changed. Add location and type information to each uniform. Besides it checks that the uniforms exists in the shader (if not the default uniforms are added).

destroy

()

Defined in kick/material/Material.js:321

getUniform

(
  • name
)
Float32Array | Int32Array | kick.texture.Texture

Defined in kick/material/Material.js:306

Parameters:

  • name Object

Returns:

Float32Array | Int32Array | kick.texture.Texture:

init

(
  • config
  • [resourceTracker]
)

Inherited from kick.core.ProjectAsset: kick/core/ProjectAsset.js:41

Configures the object using the configuration data.

Parameters:

  • config Object

    configuration data in JSON format

  • [resourceTracker] ResourceTracker optional

removeShaderChangeListener

(
  • listenerFn
)
deprecated

Defined in kick/material/Material.js:182

Parameters:

  • listenerFn Function

setUniform

(
  • name
  • value
)
kick.material.MaterialUniform

Defined in kick/material/Material.js:257

Bind material uniforms. Returns undefined or null if value is undefined or null (or uniform not found)

Parameters:

Returns:

kick.material.MaterialUniform:

toJSON

() String

Inherited from kick.core.ProjectAsset but overwritten in kick/material/Material.js:330

Returns a JSON representation of the material

Returns:

String:

Properties

name

String

Defined in kick/material/Material.js:111

renderOrder

Number

Defined in kick/material/Material.js:153

uniforms

Object deprecated

Defined in kick/material/Material.js:144

Instead call setUniform

Events

shaderChanged

Defined in kick/material/Material.js:94

Fired when shader is changed (set to a new instance)

Event Payload: