Class GlowLayer

The glow layer Helps adding a glow effect around the emissive parts of a mesh.

Once instantiated in a scene, by default, all the emissive meshes will glow.

Documentation: https://doc.babylonjs.com/features/featuresDeepDive/mesh/glowLayer

Hierarchy (View Summary)

EffectLayer
- GlowLayer

Index

Constructors

constructor

new GlowLayer(
    name: string,
    scene?: Scene,
    options?: Partial<IGlowLayerOptions>,
): GlowLayer
Instantiates a new glow Layer and references it to the scene.
Parameters
- name: string
  The name of the layer
- Optionalscene: Scene
  The scene to use the layer in
- Optionaloptions: Partial<IGlowLayerOptions>
  Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
Returns GlowLayer
Overrides EffectLayer.constructor
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:136

Properties

onAfterComposeObservable

onAfterComposeObservable: Observable<EffectLayer> = ...

An event triggered when the generated texture has been merged in the scene.

onAfterRenderMeshToEffect

onAfterRenderMeshToEffect: Observable<AbstractMesh> = ...

An event triggered after the mesh has been rendered into the effect render target.

onBeforeComposeObservable

onBeforeComposeObservable: Observable<EffectLayer> = ...

An event triggered when the generated texture is being merged in the scene.

onBeforeRenderMainTextureObservable

onBeforeRenderMainTextureObservable: Observable<EffectLayer> = ...

An event triggered when the effect layer is about rendering the main texture with the glowy parts.

onBeforeRenderMeshToEffect

onBeforeRenderMeshToEffect: Observable<AbstractMesh> = ...

An event triggered when the mesh is rendered into the effect render target.

onDisposeObservable

onDisposeObservable: Observable<EffectLayer> = ...

An event triggered when the effect layer has been disposed.

onSizeChangedObservable

onSizeChangedObservable: Observable<EffectLayer> = ...

An event triggered when the effect layer changes its size.

`Readonly`uniqueId

uniqueId: any = UniqueIdGenerator.UniqueId

The unique id of the layer

`Static`DefaultBlurKernelSize

DefaultBlurKernelSize: number = 32

The default blur kernel size used for the glow.

`Static`DefaultTextureRatio

DefaultTextureRatio: number = 0.5

The default texture size ratio used for the glow.

Accessors

blurKernelSize

get blurKernelSize(): number
Gets the kernel size of the blur.

Returns number
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:77
set blurKernelSize(value: number): void
Sets the kernel size of the blur.
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:69

camera

get camera(): Nullable<Camera>
Gets the camera attached to the layer.

Returns Nullable<Camera>
Inherited from EffectLayer.camera
- Defined in packages/dev/core/src/Layers/effectLayer.ts:173

customEmissiveColorSelector

get customEmissiveColorSelector(): (
    mesh: Mesh,
    subMesh: SubMesh,
    material: Material,
    result: Color4,
) => void
Callback used to let the user override the color selection on a per mesh basis

Returns (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:111
set customEmissiveColorSelector(
    value: (
        mesh: Mesh,
        subMesh: SubMesh,
        material: Material,
        result: Color4,
    ) => void,
): void
Parameters
- value: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:115

customEmissiveTextureSelector

get customEmissiveTextureSelector(): (
    mesh: Mesh,
    subMesh: SubMesh,
    material: Material,
) => Texture
Callback used to let the user override the texture selection on a per mesh basis

Returns (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:122
set customEmissiveTextureSelector(
value: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture,
): void
Parameters
- value: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:126

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
Inherited from EffectLayer.disableBoundingBoxesFromEffectLayer
- Defined in packages/dev/core/src/Layers/effectLayer.ts:192
set disableBoundingBoxesFromEffectLayer(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from EffectLayer.disableBoundingBoxesFromEffectLayer
- Defined in packages/dev/core/src/Layers/effectLayer.ts:196

intensity

get intensity(): number
Gets the glow intensity.

Returns number
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:92
set intensity(value: number): void
Sets the glow intensity.
Parameters
- value: number
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:84

isEnabled

get isEnabled(): boolean
Specifies whether the highlight layer is enabled or not.

Returns boolean
Inherited from EffectLayer.isEnabled
- Defined in packages/dev/core/src/Layers/effectLayer.ts:161
set isEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from EffectLayer.isEnabled
- Defined in packages/dev/core/src/Layers/effectLayer.ts:165

mainTexture

get mainTexture(): RenderTargetTexture
Gets the main texture where the effect is rendered

Returns RenderTargetTexture
Inherited from EffectLayer.mainTexture
- Defined in packages/dev/core/src/Layers/effectLayer.ts:238

name

get name(): string
The name of the layer

Returns string
Inherited from EffectLayer.name
- Defined in packages/dev/core/src/Layers/effectLayer.ts:137
set name(value: string): void
Parameters
- value: string
Returns void
Inherited from EffectLayer.name
- Defined in packages/dev/core/src/Layers/effectLayer.ts:141

neutralColor

get neutralColor(): Color4
The clear color of the texture used to generate the glow map.

Returns Color4
Inherited from EffectLayer.neutralColor
- Defined in packages/dev/core/src/Layers/effectLayer.ts:149
set neutralColor(value: Color4): void
Parameters
- value: Color4
Returns void
Inherited from EffectLayer.neutralColor
- Defined in packages/dev/core/src/Layers/effectLayer.ts:153

renderingGroupId

get renderingGroupId(): number
Gets the rendering group id the layer should render in.

Returns number
Inherited from EffectLayer.renderingGroupId
- Defined in packages/dev/core/src/Layers/effectLayer.ts:181
set renderingGroupId(renderingGroupId: number): void
Parameters
- renderingGroupId: number
Returns void
Inherited from EffectLayer.renderingGroupId
- Defined in packages/dev/core/src/Layers/effectLayer.ts:184

shaderLanguage

get shaderLanguage(): ShaderLanguage
Gets the shader language used in this material.

Returns ShaderLanguage
Inherited from EffectLayer.shaderLanguage
- Defined in packages/dev/core/src/Layers/effectLayer.ts:249

`Static`EffectName

get EffectName(): string
Effect Name of the layer.

Returns string
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:52

`Static`ForceGLSL

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
Inherited from EffectLayer.ForceGLSL
- Defined in packages/dev/core/src/Layers/effectLayer.ts:120
set ForceGLSL(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from EffectLayer.ForceGLSL
- Defined in packages/dev/core/src/Layers/effectLayer.ts:124

Methods

addExcludedMesh

addExcludedMesh(mesh: Mesh): void
Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer. This will not have an effect if meshes are excluded by default (see setExcludedByDefault).
Parameters
- mesh: Mesh
  The mesh to exclude from the glow layer
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:387

addIncludedOnlyMesh

addIncludedOnlyMesh(mesh: Mesh): void
Add a mesh in the inclusion list to impact or being impacted by the glow layer.
Parameters
- mesh: Mesh
  The mesh to include in the glow layer
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:404

dispose

dispose(): void
Dispose the highlight layer and free resources.

Returns void
Inherited from EffectLayer.dispose
- Defined in packages/dev/core/src/Layers/effectLayer.ts:655

getClassName

getClassName(): string
Gets the class name of the effect layer

Returns string
the string with the class name of the effect layer
Overrides EffectLayer.getClassName
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:473

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
Inherited from EffectLayer.getEffectIntensity
- Defined in packages/dev/core/src/Layers/effectLayer.ts:273

getEffectName

getEffectName(): string
Get the effect name of the layer.

Returns string
The effect name
Overrides EffectLayer.getEffectName
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:163

hasMesh

hasMesh(mesh: AbstractMesh): boolean
Determine if a given mesh will be used in the glow layer
Parameters
- mesh: AbstractMesh
  The mesh to test
Returns boolean
true if the mesh will be highlighted by the current glow layer
Overrides EffectLayer.hasMesh
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:430

isLayerReady

isLayerReady(): boolean
Checks if the layer is ready to be used.

Returns boolean
true if the layer is ready to be used
Inherited from EffectLayer.isLayerReady
- Defined in packages/dev/core/src/Layers/effectLayer.ts:539

isReady

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
Overrides EffectLayer.isReady
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:326

needStencil

needStencil(): boolean
Returns boolean
whether or not the layer needs stencil enabled during the mesh rendering.
Overrides EffectLayer.needStencil
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:333

referenceMeshToUseItsOwnMaterial

referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void
Add a mesh to be rendered through its own material and not with emissive only.
Parameters
- mesh: AbstractMesh
  The mesh for which we need to use its material
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:447

removeExcludedMesh

removeExcludedMesh(mesh: Mesh): void
Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer. This will not have an effect if meshes are excluded by default (see setExcludedByDefault).
Parameters
- mesh: Mesh
  The mesh to remove
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:396

removeIncludedOnlyMesh

removeIncludedOnlyMesh(mesh: Mesh): void
Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
Parameters
- mesh: Mesh
  The mesh to remove
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:412

render

render(): void
Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.

Returns void
Inherited from EffectLayer.render
- Defined in packages/dev/core/src/Layers/effectLayer.ts:546

serialize

serialize(): any
Serializes this glow layer

Returns any
a serialized glow layer object
Overrides EffectLayer.serialize
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:481

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
Inherited from EffectLayer.setEffectIntensity
- Defined in packages/dev/core/src/Layers/effectLayer.ts:282

setExcludedByDefault

setExcludedByDefault(value: boolean): void
Set the excluded by default option. If true, all meshes will be excluded by default unless they are added to the inclusion list.
Parameters
- value: boolean
  The boolean value to set the excluded by default option to
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:421

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
Inherited from EffectLayer.setMaterialForRendering
- Defined in packages/dev/core/src/Layers/effectLayer.ts:264

shouldRender

shouldRender(): boolean
Returns true if the layer contains information to display, otherwise false.

Returns boolean
true if the glow layer should be rendered
Inherited from EffectLayer.shouldRender
- Defined in packages/dev/core/src/Layers/effectLayer.ts:581

unReferenceMeshFromUsingItsOwnMaterial

unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void
Remove a mesh from being rendered through its own material and not with emissive only.
Parameters
- mesh: AbstractMesh
  The mesh for which we need to not use its material
Returns void
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:455

`Static`Parse

Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer
Creates a Glow Layer from parsed glow layer data
Parameters
- parsedGlowLayer: any
  defines glow layer data
- scene: Scene
  defines the current scene
- rootUrl: string
  defines the root URL containing the glow layer information
Returns GlowLayer
a parsed Glow Layer
Overrides EffectLayer.Parse
- Defined in packages/dev/core/src/Layers/glowLayer.pure.ts:523

Class GlowLayer

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GlowLayer

Properties

onAfterComposeObservable

onAfterRenderMeshToEffect

onBeforeComposeObservable

onBeforeRenderMainTextureObservable

onBeforeRenderMeshToEffect

onDisposeObservable

onSizeChangedObservable

ReadonlyuniqueId

StaticDefaultBlurKernelSize

StaticDefaultTextureRatio

Accessors

blurKernelSize

Returns number

Parameters

Returns void

camera

Returns Nullable<Camera>

customEmissiveColorSelector

Returns (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void

Parameters

Returns void

customEmissiveTextureSelector

Returns (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture

Parameters

Returns void

disableBoundingBoxesFromEffectLayer

Returns boolean

Parameters

Returns void

intensity

Returns number

Parameters

Returns void

isEnabled

Returns boolean

Parameters

Returns void

mainTexture

Returns RenderTargetTexture

name

Returns string

Parameters

Returns void

neutralColor

Returns Color4

Parameters

Returns void

renderingGroupId

Returns number

Parameters

Returns void

shaderLanguage

Returns ShaderLanguage

StaticEffectName

Returns string

StaticForceGLSL

Returns boolean

Parameters

Returns void

Methods

addExcludedMesh

Parameters

Returns void

addIncludedOnlyMesh

Parameters

Returns void

dispose

Returns void

`Readonly`uniqueId

`Static`DefaultBlurKernelSize

`Static`DefaultTextureRatio

`Static`EffectName

`Static`ForceGLSL

`Static`Parse