Class EffectLayerAbstract

constructor

• new EffectLayer(
      name: string,
      scene?: Scene,
      forceGLSL?: boolean,
      thinEffectLayer?: ThinEffectLayer,
  ): EffectLayer

  Instantiates a new effect Layer and references it in the scene.

  Parameters

  • name: string

    The name of the layer

  • Optionalscene: Scene

    The scene to use the layer in

  • forceGLSL: boolean = false

    Use the GLSL code generation for the shader (even on WebGPU). Default is false

  • OptionalthinEffectLayer: ThinEffectLayer

    The thin instance of the effect layer (optional)

  Returns EffectLayer

onAfterComposeObservable

onAfterRenderMeshToEffect

onBeforeComposeObservable

onBeforeRenderMainTextureObservable

onBeforeRenderMeshToEffect

onDisposeObservable

onSizeChangedObservable

ReadonlyuniqueId

camera

• get camera(): Nullable<Camera>

  Gets the camera attached to the layer.

  Returns Nullable<Camera>

disableBoundingBoxesFromEffectLayer

• get disableBoundingBoxesFromEffectLayer(): boolean

  Specifies if the bounding boxes should be rendered normally or if they should undergo the effect of the layer

  Returns boolean

• set disableBoundingBoxesFromEffectLayer(value: boolean): void

  Parameters

  • value: boolean

  Returns void

isEnabled

• get isEnabled(): boolean

  Specifies whether the highlight layer is enabled or not.

  Returns boolean

• set isEnabled(value: boolean): void

  Parameters

  • value: boolean

  Returns void

mainTexture

• get mainTexture(): RenderTargetTexture

  Gets the main texture where the effect is rendered

  Returns RenderTargetTexture

name

• get name(): string

  The name of the layer

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

neutralColor

• get neutralColor(): Color4

  The clear color of the texture used to generate the glow map.

  Returns Color4

• set neutralColor(value: Color4): void

  Parameters

  • value: Color4

  Returns void

renderingGroupId

• get renderingGroupId(): number

  Gets the rendering group id the layer should render in.

  Returns number

• set renderingGroupId(renderingGroupId: number): void

  Parameters

  • renderingGroupId: number

  Returns void

shaderLanguage

• get shaderLanguage(): ShaderLanguage

  Gets the shader language used in this material.

  Returns ShaderLanguage

StaticForceGLSL

• get ForceGLSL(): boolean

  Force all the effect layers to compile to glsl even on WebGPU engines. False by default. This is mostly meant for backward compatibility.

  Returns boolean

• set ForceGLSL(value: boolean): void

  Parameters

  • value: boolean

  Returns void

Abstract_disposeMesh

• _disposeMesh(mesh: Mesh): void

  Free any resources and references associated to a mesh. Internal use

  Parameters

  • mesh: Mesh

    The mesh to free.

  Returns void

dispose

• dispose(): void

  Dispose the highlight layer and free resources.

  Returns void

getClassName

• getClassName(): string

  Gets the class name of the effect layer

  Returns string

  the string with the class name of the effect layer

getEffectIntensity

• getEffectIntensity(mesh: AbstractMesh): number

  Gets the intensity of the effect for a specific mesh.

  Parameters

  • mesh: AbstractMesh

    The mesh to get the effect intensity for

  Returns number

  The intensity of the effect for the mesh

AbstractgetEffectName

• getEffectName(): string

  Get the effect name of the layer.

  Returns string

  The effect name

hasMesh

• hasMesh(mesh: AbstractMesh): boolean

  Determine if a given mesh will be used in the current effect.

  Parameters

  • mesh: AbstractMesh

    mesh to test

  Returns boolean

  true if the mesh will be used

isLayerReady

• isLayerReady(): boolean

  Checks if the layer is ready to be used.

  Returns boolean

  true if the layer is ready to be used

AbstractisReady

• isReady(subMesh: SubMesh, useInstances: boolean): boolean

  Checks for the readiness of the element composing the layer.

  Parameters

  • subMesh: SubMesh

    the mesh to check for

  • useInstances: boolean

    specify whether or not to use instances to render the mesh

  Returns boolean

  true if ready otherwise, false

AbstractneedStencil

• needStencil(): boolean

  Returns whether or not the layer needs stencil enabled during the mesh rendering.

  Returns boolean

  true if the effect requires stencil during the main canvas render pass.

render

• render(): void

  Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.

  Returns void

Optional Abstractserialize

• serialize?(): any

  Serializes this layer (Glow or Highlight for example)

  Returns any

  a serialized layer object

setEffectIntensity

• setEffectIntensity(mesh: AbstractMesh, intensity: number): void

  Sets the intensity of the effect for a specific mesh.

  Parameters

  • mesh: AbstractMesh

    The mesh to set the effect intensity for

  • intensity: number

    The intensity of the effect for the mesh

  Returns void

setMaterialForRendering

• setMaterialForRendering(
      mesh: AbstractMesh | AbstractMesh[],
      material?: Material,
  ): void

  Sets a specific material to be used to render a mesh/a list of meshes in the layer

  Parameters

  • mesh: AbstractMesh | AbstractMesh[]

    mesh or array of meshes

  • Optionalmaterial: Material

    material to use by the layer when rendering the mesh(es). If undefined is passed, the specific material created by the layer will be used.

  Returns void

shouldRender

• shouldRender(): boolean

  Returns true if the layer contains information to display, otherwise false.

  Returns boolean

  true if the glow layer should be rendered

StaticParse

• Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer

  Creates an effect layer from parsed effect layer data

  Parameters

  • parsedEffectLayer: any

    defines effect layer data

  • scene: Scene

    defines the current scene

  • rootUrl: string

    defines the root URL containing the effect layer information

  Returns EffectLayer

  a parsed effect Layer