Options
All
  • Public
  • Public/Protected
  • All
Menu

Class used to create a node based material built by assembling shader blocks

Hierarchy

  • PushMaterial
    • NodeMaterial

Index

Constructors

Properties

Accessors

Methods

Constructors

  • Create a new node based material

    Parameters

    • name: string

      defines the material name

    • Optional scene: Scene

      defines the hosting scene

    • Optional options: Partial<INodeMaterialOptions>

      defines creation option

    Returns NodeMaterial

Properties

_fragmentOutputNodes: NodeMaterialBlock[]

Gets or sets the root nodes of the material fragment (pixel) shader

_vertexOutputNodes: NodeMaterialBlock[]

Gets or sets the root nodes of the material vertex shader

allowShaderHotSwapping: boolean

Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping. This means that the material can keep using a previous shader while a new one is being compiled. This is mostly used when shader parallel compilation is supported (true by default)

animations: Nullable<Animation[]>

Stores the animations for the material

attachedBlocks: NodeMaterialBlock[]

Gets an array of blocks that needs to be serialized even if they are not yet connected

checkReadyOnEveryCall: boolean

Specifies if the ready state should be checked on each call

checkReadyOnlyOnce: boolean

Specifies if the ready state should be checked once

clipPlane: Nullable<Plane>

Gets or sets the active clipplane 1

clipPlane2: Nullable<Plane>

Gets or sets the active clipplane 2

clipPlane3: Nullable<Plane>

Gets or sets the active clipplane 3

clipPlane4: Nullable<Plane>

Gets or sets the active clipplane 4

clipPlane5: Nullable<Plane>

Gets or sets the active clipplane 5

clipPlane6: Nullable<Plane>

Gets or sets the active clipplane 6

comment: string

A free comment about the material

customShaderNameResolve: ((shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: string[] | MaterialDefines, attributes?: string[], options?: ICustomShaderNameResolveOptions) => string)

Type declaration

    • Custom callback helping to override the default shader used in the material.

      Parameters

      Returns string

depthFunction: number

Specifies the depth function that should be used. 0 means the default engine function

disableColorWrite: boolean

Specifies if color writing should be disabled

disableDepthWrite: boolean

Specifies if depth writing should be disabled

doNotSerialize: boolean

Specifies if the material should be serialized

editorData: any

Gets or sets data used by visual editor

see

https://nme.babylonjs.com

forceAlphaBlending: boolean

Gets or sets a boolean indicating that alpha blending must be enabled no matter what alpha value or alpha channel of the FragmentBlock are

forceDepthWrite: boolean

Specifies if depth writing should be forced

getRenderTargetTextures: Nullable<(() => SmartArray<RenderTargetTexture>)>

Callback triggered to get the render target textures

id: string

The ID of the material

ignoreAlpha: boolean

Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)

inspectableCustomProperties: IInspectable[]

List of inspectable custom properties (used by the Inspector)

see

https://doc.babylonjs.com/toolsAndResources/inspector#extensibility

maxSimultaneousLights: number

Defines the maximum number of lights that can be used in the material

metadata: any

Gets or sets user defined metadata

name: string

The name of the material

onBuildObservable: Observable<NodeMaterial>

Observable raised when the material is built

onCompiled: Nullable<((effect: Effect) => void)>

Callback triggered when the material is compiled

onDisposeObservable: Observable<Material>

An event triggered when the material is disposed

onError: Nullable<((effect: Effect, errors: string) => void)>

Callback triggered when an error occurs

pluginManager?: MaterialPluginManager

Plugin manager for this material

pointSize: number

Stores the size of points

reservedDataStore: any

For internal use only. Please do not use.

separateCullingPass: boolean

Specifies if there should be a separate pass for culling

shadowDepthWrapper: Nullable<ShadowDepthWrapper>

Custom shadow depth material to use for shadow rendering instead of the in-built one

sideOrientation: number

Stores the value for side orientation

snippetId: string

Snippet ID if the material was created from the snippet server

state: string

The state of the material

Gives access to the stencil properties of the material

uniqueId: number

Gets or sets the unique id of the material

zOffset: number

Stores the z offset Factor value

zOffsetUnits: number

Stores the z offset Units value

AllDirtyFlag: 63 = 63

The all dirty flag value

AttributesDirtyFlag: 8 = 8

The dirty attribute flag value

ClockWiseSideOrientation: 0 = 0

Stores the clock-wise side orientation

CounterClockWiseSideOrientation: 1 = 1

Stores the counter clock-wise side orientation

EditorURL: string

Define the Url to load node editor script

FresnelDirtyFlag: 4 = 4

The dirty fresnel flag value

IgnoreTexturesAtLoadTime: boolean

Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content

LightDirtyFlag: 2 = 2

The dirty light flag value

LineListDrawMode: 4 = 4

Returns the line list draw mode

LineLoopDrawMode: 5 = 5

Returns the line loop draw mode

LineStripDrawMode: 6 = 6

Returns the line strip draw mode

MATERIAL_ALPHABLEND: 2 = 2

MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.

MATERIAL_ALPHATEST: 1 = 1

MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.

MATERIAL_ALPHATESTANDBLEND: 3 = 3

MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer. They are also discarded below the alpha cutoff threshold to improve performances.

MATERIAL_NORMALBLENDMETHOD_RNM: 1 = 1

The Reoriented Normal Mapping method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/

MATERIAL_NORMALBLENDMETHOD_WHITEOUT: 0 = 0

The Whiteout method is used to blend normals. Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/

MATERIAL_OPAQUE: 0 = 0

MaterialTransparencyMode: No transparency mode, Alpha channel is not use.

MiscDirtyFlag: 16 = 16

The dirty misc flag value

OnEventObservable: Observable<Material>

Event observable which raises global events common to all materials (like MaterialPluginEvent.Created)

PointFillMode: 2 = 2

Returns the point fill mode

PointListDrawMode: 3 = 3

Returns the point list draw mode

PrePassDirtyFlag: 32 = 32

The dirty prepass flag value

SnippetUrl: string

Define the Url to load snippets

TextureDirtyFlag: 1 = 1

The dirty texture flag value

TriangleFanDrawMode: 8 = 8

Returns the triangle fan draw mode

TriangleFillMode: 0 = 0

Returns the triangle fill mode

TriangleStripDrawMode: 7 = 7

Returns the triangle strip draw mode

WireFrameFillMode: 1 = 1

Returns the wireframe mode

Accessors

  • get alpha(): number
  • set alpha(value: number): void
  • Gets the alpha value of the material

    Returns number

  • Sets the alpha value of the material

    Parameters

    • value: number

    Returns void

  • get alphaMode(): number
  • set alphaMode(value: number): void
  • Gets the value of the alpha mode

    ValueTypeDescription
    0ALPHA_DISABLE
    1ALPHA_ADD
    2ALPHA_COMBINE
    3ALPHA_SUBTRACT
    4ALPHA_MULTIPLY
    5ALPHA_MAXIMIZED
    6ALPHA_ONEONE
    7ALPHA_PREMULTIPLIED
    8ALPHA_PREMULTIPLIED_PORTERDUFF
    9ALPHA_INTERPOLATE
    10ALPHA_SCREENMODE

    Returns number

  • Sets the value of the alpha mode.

    ValueTypeDescription
    0ALPHA_DISABLE
    1ALPHA_ADD
    2ALPHA_COMBINE
    3ALPHA_SUBTRACT
    4ALPHA_MULTIPLY
    5ALPHA_MAXIMIZED
    6ALPHA_ONEONE
    7ALPHA_PREMULTIPLIED
    8ALPHA_PREMULTIPLIED_PORTERDUFF
    9ALPHA_INTERPOLATE
    10ALPHA_SCREENMODE

    Parameters

    • value: number

    Returns void

  • get backFaceCulling(): boolean
  • set backFaceCulling(value: boolean): void
  • Gets the culling state

    Returns boolean

  • Sets the culling state (true to enable culling, false to disable)

    Parameters

    • value: boolean

    Returns void

  • get blockDirtyMechanism(): boolean
  • set blockDirtyMechanism(value: boolean): void
  • Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.

    Returns boolean

  • Block the dirty-mechanism for this specific material When set to false after being true the material will be marked as dirty.

    Parameters

    • value: boolean

    Returns void

  • get buildId(): number
  • set buildId(value: number): void
  • Gets or sets the unique identifier used to identified the effect associated with the material

    Returns number

  • Gets or sets the unique identifier used to identified the effect associated with the material

    Parameters

    • value: number

    Returns void

  • get canRenderToMRT(): boolean
  • If the material can be rendered to several textures with MRT extension

    Returns boolean

  • get compiledShaders(): string
  • Get a string representing the shaders built by the current node graph

    Returns string

  • get cullBackFaces(): boolean
  • set cullBackFaces(value: boolean): void
  • Gets the type of faces that should be culled

    Returns boolean

  • Sets the type of faces that should be culled (true for back faces, false for front faces)

    Parameters

    • value: boolean

    Returns void

  • get fillMode(): number
  • set fillMode(value: number): void
  • Gets the material fill mode

    Returns number

  • Sets the material fill mode

    Parameters

    • value: number

    Returns void

  • get fogEnabled(): boolean
  • set fogEnabled(value: boolean): void
  • Gets the value of the fog enabled state

    Returns boolean

  • Sets the state for enabling fog

    Parameters

    • value: boolean

    Returns void

  • get hasRenderTargetTextures(): boolean
  • Gets a boolean indicating that current material needs to register RTT

    Returns boolean

  • Gets the image processing configuration used either in this material.

    Returns ImageProcessingConfiguration

  • Sets the Default image processing configuration used either in the this material.

    If sets to null, the scene one is in use.

    Parameters

    Returns void

  • get isFrozen(): boolean
  • Specifies if updates for the material been locked

    Returns boolean

  • get isPrePassCapable(): boolean
  • Can this material render to prepass

    Returns boolean

  • Gets or sets the mode property

    Returns NodeMaterialModes

  • Gets or sets the mode property

    Parameters

    Returns void

  • get needDepthPrePass(): boolean
  • set needDepthPrePass(value: boolean): void
  • Gets the depth pre-pass value

    Returns boolean

  • Sets the need depth pre-pass value

    Parameters

    • value: boolean

    Returns void

  • Called during a bind event

    Parameters

    Returns void

  • An event triggered when the material is bound

    Returns Observable<AbstractMesh>

  • set onDispose(callback: (() => void)): void
  • Called during a dispose event

    Parameters

    • callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • An event triggered when the effect is (re)created

    Returns Observable<{ effect: Effect; subMesh: Nullable<SubMesh> }>

  • An event triggered when the material is unbound

    Returns Observable<Material>

  • Gets or sets options to control the node material overall behavior

    Returns INodeMaterialOptions

  • Gets or sets options to control the node material overall behavior

    Parameters

    Returns void

  • get pointsCloud(): boolean
  • set pointsCloud(value: boolean): void
  • Gets the value specifying if point clouds are enabled

    Returns boolean

  • Sets the state of point cloud mode

    Parameters

    • value: boolean

    Returns void

  • get transparencyMode(): Nullable<number>
  • set transparencyMode(value: Nullable<number>): void
  • Gets the current transparency mode.

    Returns Nullable<number>

  • Sets the transparency mode of the material.

    ValueTypeDescription
    0OPAQUE
    1ALPHATEST
    2ALPHABLEND
    3ALPHATESTANDBLEND

    Parameters

    Returns void

  • get wireframe(): boolean
  • set wireframe(value: boolean): void
  • Returns boolean

  • Sets the state of wireframe mode

    Parameters

    • value: boolean

    Returns void

Methods

  • Add a new block to the list of output nodes

    Parameters

    Returns NodeMaterial

    the current material

  • atomicMaterialsUpdate(callback: ((material: NodeMaterial) => void)): void
  • This allows you to modify the material without marking it as dirty after every change. This function should be used if you need to make more than one dirty-enabling change to the material - adding a texture, setting a new fill mode and so on. The callback will pass the material as an argument, so you can make your changes to it.

    Parameters

    Returns void

  • Parameters

    Returns void

  • bindEyePosition(effect: Effect, variableName?: string): void
  • Binds the view matrix to the effect

    Parameters

    • effect: Effect

      defines the effect to bind the view matrix to

    • Optional variableName: string

      name of the shader variable that will hold the eye position

    Returns void

  • Binds the submesh to this material by preparing the effect and shader to draw

    Parameters

    • world: Matrix

      defines the world transformation matrix

    • mesh: Mesh

      defines the mesh containing the submesh

    • subMesh: SubMesh

      defines the submesh to bind the material to

    Returns void

  • bindOnlyNormalMatrix(normalMatrix: Matrix): void
  • Binds the given normal matrix to the active effect

    Parameters

    • normalMatrix: Matrix

      the matrix to bind

    Returns void

  • bindOnlyWorldMatrix(world: Matrix): void
  • Binds the world matrix to the material

    Parameters

    • world: Matrix

      defines the world transformation matrix

    Returns void

  • bindView(effect: Effect): void
  • Binds the view matrix to the effect

    Parameters

    • effect: Effect

      defines the effect to bind the view matrix to

    Returns void

  • bindViewProjection(effect: Effect): void
  • Binds the view projection and projection matrices to the effect

    Parameters

    • effect: Effect

      defines the effect to bind the view projection and projection matrices to

    Returns void

  • build(verbose?: boolean, updateBuildId?: boolean, autoConfigure?: boolean): void
  • Build the material and generates the inner effect

    Parameters

    • Optional verbose: boolean

      defines if the build should log activity

    • Optional updateBuildId: boolean

      defines if the internal build Id should be updated (default is true)

    • Optional autoConfigure: boolean

      defines if the autoConfigure method should be called when initializing blocks (default is true)

    Returns void

  • buildUniformLayout(): void
  • Initializes the uniform buffer layout for the shader.

    Returns void

  • clear(): void
  • Clear the current material

    Returns void

  • Makes a duplicate of the current material.

    Parameters

    • name: string

      defines the name to use for the new material

    • Optional shareEffect: boolean

      defines if the clone material should share the same effect (default is false)

    Returns NodeMaterial

  • createAsShadowDepthWrapper(targetMaterial: Material): void
  • Use this material as the shadow depth wrapper of a target material

    Parameters

    • targetMaterial: Material

      defines the target material

    Returns void

  • createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: ((effect: Effect) => void), onError?: ((effect: Effect, errors: string) => void)): void
  • Create the effect to be used as the custom effect for a particle system

    Parameters

    • particleSystem: IParticleSystem

      Particle system to create the effect for

    • Optional onCompiled: ((effect: Effect) => void)

      defines a function to call when the effect creation is successful

    • Optional onError: ((effect: Effect, errors: string) => void)

      defines a function to call when the effect creation has failed

        • (effect: Effect, errors: string): void
        • Parameters

          Returns void

    Returns void

  • createEffectForPostProcess(postProcess: PostProcess): void
  • Create the post process effect from the material

    Parameters

    • postProcess: PostProcess

      The post process to create the effect for

    Returns void

  • Create a post process from the material

    Parameters

    • camera: Nullable<Camera>

      The camera to apply the render pass to.

    • Optional options: number | PostProcessOptions

      The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)

    • Optional samplingMode: number

      The sampling mode to be used when computing the pass. (default: 0)

    • Optional engine: Engine

      The engine which the post process will be applied. (default: current engine)

    • Optional reusable: boolean

      If the post process can be reused on the same frame. (default: false)

    • Optional textureType: number

      Type of textures used when performing the post process. (default: 0)

    • Optional textureFormat: number

      Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)

    Returns Nullable<PostProcess>

    the post process created

  • Create a new procedural texture based on this node material

    Parameters

    • size: number | { height: number; layers?: number; width: number }

      defines the size of the texture

    • scene: Scene

      defines the hosting scene

    Returns Nullable<ProceduralTexture>

    the new procedural texture attached to this node material

  • dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void
  • Disposes the material

    Parameters

    • Optional forceDisposeEffect: boolean

      specifies if effects should be forcefully disposed

    • Optional forceDisposeTextures: boolean

      specifies if textures should be forcefully disposed

    • Optional notBoundToMesh: boolean

      specifies if the material that is being disposed is known to be not bound to any mesh

    Returns void

  • Launch the node material editor

    Parameters

    Returns Promise<void>

    a promise fulfilled when the node editor is visible

  • Force shader compilation

    Parameters

    • mesh: AbstractMesh

      defines the mesh associated with this material

    • Optional onCompiled: ((material: Material) => void)

      defines a function to execute once the material is compiled

    • Optional options: Partial<IMaterialCompilationOptions>

      defines the options to configure the compilation

    • Optional onError: ((reason: string) => void)

      defines a function to execute if the material fails compiling

        • (reason: string): void
        • Parameters

          • reason: string

          Returns void

    Returns void

  • Force shader compilation

    Parameters

    Returns Promise<void>

    a promise that resolves when the compilation completes

  • freeze(): void
  • Locks updates for the material

    Returns void

  • generateCode(): string
  • Generate a string containing the code declaration required to create an equivalent of this material

    Returns string

    a string

  • Gets the active textures from the material

    Returns BaseTexture[]

    an array of textures

  • Gets the texture used for the alpha test

    Returns Nullable<BaseTexture>

    the texture to use for alpha testing

  • Returns the animatable textures.

    Returns IAnimatable[]

    • Array of animatable textures.
  • Gets the meshes bound to the material

    Returns AbstractMesh[]

    an array of meshes bound to the material

  • Get a block by its name

    Parameters

    • name: string

      defines the name of the block to retrieve

    Returns null | NodeMaterialBlock

    the required block or null if not found

  • Get a block by its name

    Parameters

    Returns null | NodeMaterialBlock

    the required block or null if not found

  • getClassName(): string
  • Gets the current class name of the material e.g. "NodeMaterial"

    Returns string

    the class name

  • Returns Effect

  • Get an input block by its name

    Parameters

    • predicate: ((block: InputBlock) => boolean)

      defines the predicate used to find the good candidate

    Returns Nullable<InputBlock>

    the required input block or null if not found

  • Gets the list of input blocks attached to this material

    Returns InputBlock[]

    an array of InputBlocks

  • Returns the current scene

    Returns Scene

    a Scene

  • Specifies if the material uses a texture

    Parameters

    • texture: BaseTexture

      defines the texture to check against the material

    Returns boolean

    a boolean specifying if the material uses the texture

  • isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean
  • Parameters

    Returns boolean

  • Get if the submesh is ready to be used and all its information available. Child classes can use it to update shaders

    Parameters

    • mesh: AbstractMesh

      defines the mesh to check

    • subMesh: SubMesh

      defines which submesh to check

    • Optional useInstances: boolean

      specifies that instances should be used

    Returns boolean

    a boolean indicating that the submesh is ready or not

  • loadAsync(url: string, rootUrl?: string): Promise<NodeMaterial>
  • Loads the current Node Material from a url pointing to a file save by the Node Material Editor

    deprecated

    Please use NodeMaterial.ParseFromFileAsync instead

    Parameters

    • url: string

      defines the url to load from

    • Optional rootUrl: string

      defines the root URL for nested url in the node material

    Returns Promise<NodeMaterial>

    a promise that will fulfil when the material is fully loaded

  • loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void
  • Clear the current graph and load a new one from a serialization object

    deprecated

    Please use the parseSerializedObject method instead

    Parameters

    • source: any

      defines the JSON representation of the material

    • Optional rootUrl: string

      defines the root URL to use to load textures and relative dependencies

    • Optional merge: boolean

      defines whether or not the source must be merged or replace the current content

    Returns void

  • markAsDirty(flag: number): void
  • Marks a define in the material to indicate that it needs to be re-computed

    Parameters

    • flag: number

      defines a flag used to determine which parts of the material have to be marked as dirty

    Returns void

  • markDirty(): void
  • Marks the material to indicate that it needs to be re-calculated

    Returns void

  • needAlphaBlending(): boolean
  • Specifies if the material will require alpha blending

    Returns boolean

    a boolean specifying if alpha blending is needed

  • Specifies if the mesh will require alpha blending

    Parameters

    Returns boolean

    a boolean specifying if alpha blending is needed for the mesh

  • needAlphaTesting(): boolean
  • Specifies if this material should be rendered in alpha test mode

    Returns boolean

    a boolean specifying if an alpha test is needed.

  • optimize(): void
  • Runs an otpimization phase to try to improve the shader code

    Returns void

  • parseSerializedObject(source: any, rootUrl?: string, merge?: boolean): void
  • Clear the current graph and load a new one from a serialization object

    Parameters

    • source: any

      defines the JSON representation of the material

    • Optional rootUrl: string

      defines the root URL to use to load textures and relative dependencies

    • Optional merge: boolean

      defines whether or not the source must be merged or replace the current content

    Returns void

  • Adds a new optimizer to the list of optimizers

    Parameters

    Returns undefined | NodeMaterial

    the current material

  • Remove a block from the current node material

    Parameters

    Returns void

  • Remove a block from the list of root nodes

    Parameters

    Returns NodeMaterial

    the current material

  • resetDrawCache(): void
  • Resets the draw wrappers cache for all submeshes that are using this material

    Returns void

  • Serializes this material in a JSON representation

    Parameters

    Returns any

    the serialized material object

  • Sets the required values to the prepass renderer.

    Parameters

    Returns boolean

    true if the pre pass is needed.

  • setToDefault(): void
  • Clear the current material and set it to a default state

    Returns void

  • setToDefaultParticle(): void
  • Clear the current material and set it to a default state for particle

    Returns void

  • setToDefaultPostProcess(): void
  • Clear the current material and set it to a default state for post process

    Returns void

  • setToDefaultProceduralTexture(): void
  • Clear the current material and set it to a default state for procedural texture

    Returns void

  • toString(fullDetails?: boolean): string
  • Returns a string representation of the current material

    Parameters

    • Optional fullDetails: boolean

      defines a boolean indicating which levels of logging is desired

    Returns string

    a string with material information

  • unbind(): void
  • Unbinds the material from the mesh

    Returns void

  • unfreeze(): void
  • Unlocks updates for the material

    Returns void

  • Remove an optimizer from the list of optimizers

    Parameters

    Returns undefined | NodeMaterial

    the current material

  • Creates a new node material set to default basic configuration

    Parameters

    • name: string

      defines the name of the material

    • Optional scene: Scene

      defines the hosting scene

    Returns NodeMaterial

    a new NodeMaterial

  • Creates a node material from parsed material data

    Parameters

    • source: any

      defines the JSON representation of the material

    • scene: Scene

      defines the hosting scene

    • Optional rootUrl: string

      defines the root URL to use to load textures and relative dependencies

    Returns NodeMaterial

    a new node material

  • ParseFromFileAsync(name: string, url: string, scene: Scene, rootUrl?: string, skipBuild?: boolean, targetMaterial?: NodeMaterial): Promise<NodeMaterial>
  • Creates a node material from a snippet saved in a remote file

    Parameters

    • name: string

      defines the name of the material to create

    • url: string

      defines the url to load from

    • scene: Scene

      defines the hosting scene

    • Optional rootUrl: string

      defines the root URL for nested url in the node material

    • Optional skipBuild: boolean

      defines whether to build the node material

    • Optional targetMaterial: NodeMaterial

      defines a material to use instead of creating a new one

    Returns Promise<NodeMaterial>

    a promise that will resolve to the new node material

  • ParseFromSnippetAsync(snippetId: string, scene?: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial, skipBuild?: boolean): Promise<NodeMaterial>
  • Creates a node material from a snippet saved by the node material editor

    Parameters

    • snippetId: string

      defines the snippet to load

    • Optional scene: Scene

      defines the hosting scene

    • Optional rootUrl: string

      defines the root URL to use to load textures and relative dependencies

    • Optional nodeMaterial: NodeMaterial

      defines a node material to update (instead of creating a new one)

    • Optional skipBuild: boolean

      defines whether to build the node material

    Returns Promise<NodeMaterial>

    a promise that will resolve to the new node material

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Static property
  • Static method

Settings

Theme