Class MaterialPluginBase

Base class for material plugins.

since: 5.0

Hierarchy

MaterialPluginBase

Constructors

constructor

new MaterialPluginBase(material: Material, name: string, priority: number, defines?: {}, addToPluginList?: boolean, enable?: boolean): MaterialPluginBase

- Defined in .temp/docdirectory/doc.d.ts:37236
Creates a new material plugin

Parameters
- material: Material
  
  parent material of the plugin
- name: string
  
  name of the plugin
- priority: number
  
  priority of the plugin
- Optional defines: {}
  
  list of defines used by the plugin. The value of the property is the default value for this property
  - [key: string]: any
- Optional addToPluginList: boolean
  
  true to add the plugin to the list of plugins managed by the material plugin manager of the material (default: true)
- Optional enable: boolean
  
  true to enable the plugin (it is handy if the plugin does not handle properties to switch its current activation)
Returns MaterialPluginBase

Properties

Readonly markAllDefinesAsDirtySearch playground for markAllDefinesAsDirty

markAllDefinesAsDirty: () => void

Helper function to mark defines as being dirty.

Type declaration

- (): void
- Returns void

nameSearch playground for name

name: string

Defines the name of the plugin

prioritySearch playground for priority

priority: number

Defines the priority of the plugin. Lower numbers run first.

registerForExtraEventsSearch playground for registerForExtraEvents

registerForExtraEvents: boolean

Indicates that this plugin should be notified for the extra events (HasRenderTargetTextures / FillRenderTargetTextures / HardBindForSubMesh)

Methods

addFallbacksSearch playground for addFallbacks

addFallbacks(defines: MaterialDefines, fallbacks: EffectFallbacks, currentRank: number): number

- Defined in .temp/docdirectory/doc.d.ts:37352
Add fallbacks to the effect fallbacks list.

Parameters
- defines: MaterialDefines
  
  defines the Base texture to use.
- fallbacks: EffectFallbacks
  
  defines the current fallback list.
- currentRank: number
  
  defines the current fallback rank.
Returns number

the new fallback rank.

bindForSubMeshSearch playground for bindForSubMesh

bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, subMesh: SubMesh): void

- Defined in .temp/docdirectory/doc.d.ts:37278
Binds the material data.

Parameters
- uniformBuffer: UniformBuffer
  
  defines the Uniform buffer to fill in.
- scene: Scene
  
  defines the scene the material belongs to.
- engine: Engine
  
  the engine this scene belongs to.
- subMesh: SubMesh
  
  the submesh to bind data for
Returns void

collectDefinesSearch playground for collectDefines

collectDefines(defines: {}): void

- Defined in .temp/docdirectory/doc.d.ts:37299
Collects all defines.

Parameters
- defines: {}
  
  The object to append to.
  - [name: string]: { default: any; type: string }
    - default: any
    - type: string
Returns void

copyToSearch playground for copyTo

copyTo(plugin: MaterialPluginBase): void

- Defined in .temp/docdirectory/doc.d.ts:37387
Makes a duplicate of the current configuration into another one.

Parameters
- plugin: MaterialPluginBase
  
  define the config where to copy the info
Returns void

disposeSearch playground for dispose

dispose(forceDisposeTextures?: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:37283
Disposes the resources of the material.

Parameters
- Optional forceDisposeTextures: boolean
  
  Forces the disposal of all textures.
Returns void

fillRenderTargetTexturesSearch playground for fillRenderTargetTextures

fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void

- Defined in .temp/docdirectory/doc.d.ts:37334
Fills the list of render target textures.

Parameters
- renderTargets: SmartArray<RenderTargetTexture>
  
  the list of render targets to update
Returns void

getActiveTexturesSearch playground for getActiveTextures

getActiveTextures(activeTextures: BaseTexture[]): void

- Defined in .temp/docdirectory/doc.d.ts:37339
Returns an array of the actively used textures.

Parameters
- activeTextures: BaseTexture[]
  
  Array of BaseTextures
Returns void

getAnimatablesSearch playground for getAnimatables

getAnimatables(animatables: IAnimatable[]): void

- Defined in .temp/docdirectory/doc.d.ts:37344
Returns the animatable textures.

Parameters
- animatables: IAnimatable[]
  
  Array of animatable textures.
Returns void

getAttributesSearch playground for getAttributes

getAttributes(attributes: string[], scene: Scene, mesh: AbstractMesh): void

- Defined in .temp/docdirectory/doc.d.ts:37364
Gets the attributes used by the plugin.

Parameters
- attributes: string[]
  
  list that the attribute names should be added to.
- scene: Scene
  
  the scene that the material belongs to.
- mesh: AbstractMesh
  
  the mesh being rendered.
Returns void

getClassNameSearch playground for getClassName

getClassName(): string

- Defined in .temp/docdirectory/doc.d.ts:37253
Gets the current class name useful for serialization or dynamic coding.

Returns string

The class name.

getCustomCodeSearch playground for getCustomCode

getCustomCode(shaderType: string): Nullable<{}>

- Defined in .temp/docdirectory/doc.d.ts:37292
Returns a list of custom shader code fragments to customize the shader.

Parameters
- shaderType: string
  
  "vertex" or "fragment"
Returns Nullable<{}>

null if no code to be added, or a list of pointName => code. Note that pointName can also be a regular expression if it starts with a !. In that case, the string found by the regular expression (if any) will be replaced by the code provided.

getSamplersSearch playground for getSamplers

getSamplers(samplers: string[]): void

- Defined in .temp/docdirectory/doc.d.ts:37357
Gets the samplers used by the plugin.

Parameters
- samplers: string[]
  
  list that the sampler names should be added to.
Returns void

getUniformBuffersNamesSearch playground for getUniformBuffersNames

getUniformBuffersNames(ubos: string[]): void

- Defined in .temp/docdirectory/doc.d.ts:37369
Gets the uniform buffers names added by the plugin.

Parameters
- ubos: string[]
  
  list that the ubo names should be added to.
Returns void

getUniformsSearch playground for getUniforms

getUniforms(): { fragment?: string; ubo?: Array<{ name: string; size: number; type: string }>; vertex?: string }

- Defined in .temp/docdirectory/doc.d.ts:37374
Gets the description of the uniforms to add to the ubo (if engine supports ubos) or to inject directly in the vertex/fragment shaders (if engine does not support ubos)

Returns { fragment?: string; ubo?: Array<{ name: string; size: number; type: string }>; vertex?: string }

the description of the uniforms
- Optional fragment?: string
- Optional ubo?: Array<{ name: string; size: number; type: string }>
- Optional vertex?: string

hardBindForSubMeshSearch playground for hardBindForSubMesh

hardBindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, subMesh: SubMesh): void

- Defined in .temp/docdirectory/doc.d.ts:37270
Binds the material data (this function is called even if mustRebind() returns false)

Parameters
- uniformBuffer: UniformBuffer
  
  defines the Uniform buffer to fill in.
- scene: Scene
  
  defines the scene the material belongs to.
- engine: Engine
  
  defines the engine the material belongs to.
- subMesh: SubMesh
  
  the submesh to bind data for
Returns void

hasRenderTargetTexturesSearch playground for hasRenderTargetTextures

hasRenderTargetTextures(): boolean

- Defined in .temp/docdirectory/doc.d.ts:37329
Gets a boolean indicating that current material needs to register RTT

Returns boolean

true if this uses a render target otherwise false.

hasTextureSearch playground for hasTexture

hasTexture(texture: BaseTexture): boolean

- Defined in .temp/docdirectory/doc.d.ts:37324
Checks to see if a texture is used in the material.

Parameters
- texture: BaseTexture
  
  Base texture to use.
Returns boolean
- Boolean specifying if a texture is used in the material.

isReadyForSubMeshSearch playground for isReadyForSubMesh

isReadyForSubMesh(defines: MaterialDefines, scene: Scene, engine: Engine, subMesh: SubMesh): boolean

- Defined in .temp/docdirectory/doc.d.ts:37262
Specifies that the submesh is ready to be used.

Parameters
- defines: MaterialDefines
  
  the list of "defines" to update.
- scene: Scene
  
  defines the scene the material belongs to.
- engine: Engine
  
  the engine this scene belongs to.
- subMesh: SubMesh
  
  the submesh to check for readiness
Returns boolean
- boolean indicating that the submesh is ready or not.

parseSearch playground for parse

parse(source: any, scene: Scene, rootUrl: string): void

- Defined in .temp/docdirectory/doc.d.ts:37399
Parses a anisotropy Configuration from a serialized object.

Parameters
- source: any
  
  Serialized object.
- scene: Scene
  
  Defines the scene we are parsing for
- rootUrl: string
  
  Defines the rootUrl to load from
Returns void

prepareDefinesSearch playground for prepareDefines

prepareDefines(defines: MaterialDefines, scene: Scene, mesh: AbstractMesh): void

- Defined in .temp/docdirectory/doc.d.ts:37318
Sets the defines for the next rendering

Parameters
- defines: MaterialDefines
  
  the list of "defines" to update.
- scene: Scene
  
  defines the scene to the material belongs to.
- mesh: AbstractMesh
  
  the mesh being rendered
Returns void

prepareDefinesBeforeAttributesSearch playground for prepareDefinesBeforeAttributes

prepareDefinesBeforeAttributes(defines: MaterialDefines, scene: Scene, mesh: AbstractMesh): void

- Defined in .temp/docdirectory/doc.d.ts:37311
Sets the defines for the next rendering. Called before MaterialHelper.PrepareDefinesForAttributes is called.

Parameters
- defines: MaterialDefines
  
  the list of "defines" to update.
- scene: Scene
  
  defines the scene to the material belongs to.
- mesh: AbstractMesh
  
  the mesh being rendered
Returns void

serializeSearch playground for serialize

serialize(): any

- Defined in .temp/docdirectory/doc.d.ts:37392
Serializes this clear coat configuration.

Returns any
- An object with the serialized config.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

material: Material

name: string

priority: number

Optional defines: {}

[key: string]: any

Optional addToPluginList: boolean

Optional enable: boolean

Returns MaterialPluginBase

Properties

Readonly markAllDefinesAsDirtySearch playground for markAllDefinesAsDirty

Type declaration

Returns void

nameSearch playground for name

prioritySearch playground for priority

registerForExtraEventsSearch playground for registerForExtraEvents

Methods

addFallbacksSearch playground for addFallbacks

Parameters

defines: MaterialDefines

fallbacks: EffectFallbacks

currentRank: number

Returns number

bindForSubMeshSearch playground for bindForSubMesh

Parameters

uniformBuffer: UniformBuffer

scene: Scene

engine: Engine

subMesh: SubMesh

Returns void

collectDefinesSearch playground for collectDefines

Parameters

defines: {}

[name: string]: { default: any; type: string }

default: any

type: string

Returns void

copyToSearch playground for copyTo

Parameters

plugin: MaterialPluginBase

Returns void

disposeSearch playground for dispose

Parameters

Optional forceDisposeTextures: boolean

Returns void

fillRenderTargetTexturesSearch playground for fillRenderTargetTextures

Parameters

renderTargets: SmartArray<RenderTargetTexture>

Returns void

getActiveTexturesSearch playground for getActiveTextures

Parameters

activeTextures: BaseTexture[]

Returns void

getAnimatablesSearch playground for getAnimatables

Parameters

animatables: IAnimatable[]

Returns void

getAttributesSearch playground for getAttributes

Parameters

attributes: string[]

scene: Scene

mesh: AbstractMesh

Returns void

getClassNameSearch playground for getClassName

Returns string

getCustomCodeSearch playground for getCustomCode

Parameters

shaderType: string

Returns Nullable<{}>

getSamplersSearch playground for getSamplers

Parameters

samplers: string[]

Returns void