Class GlowLayer
Hierarchy
- EffectLayer
- GlowLayer
Index
Constructors
Properties
- custom
Emissive Color Selector - custom
Emissive Texture Selector - disable
Bounding Boxes From Effect Layer - is
Enabled - name
- neutral
Color - on
After Compose Observable - on
After Render Mesh To Effect - on
Before Compose Observable - on
Before Render Main Texture Observable - on
Before Render Mesh To Effect - on
Dispose Observable - on
Size Changed Observable - Default
Blur Kernel Size - Default
Texture Ratio - Effect
Name
Accessors
Methods
Constructors
constructor
Instantiates a new glow Layer and references it to the scene.
Parameters
name: string
The name of the layer
Optional scene: Scene
The scene to use the layer in
Optional options: Partial<IGlowLayerOptions>
Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
Returns GlowLayer
Properties
custom
custom
disable
Specifies if the bounding boxes should be rendered normally or if they should undergo the effect of the layer
is
Specifies whether the highlight layer is enabled or not.
nameSearch playground for name
The name of the layer
neutral
The clear color of the texture used to generate the glow map.
on
An event triggered when the generated texture has been merged in the scene.
on
An event triggered after the mesh has been rendered into the effect render target.
on
An event triggered when the generated texture is being merged in the scene.
on
An event triggered when the effect layer is about rendering the main texture with the glowy parts.
on
An event triggered when the mesh is rendered into the effect render target.
on
An event triggered when the effect layer has been disposed.
on
An event triggered when the effect layer changes its size.
Static Default
The default blur kernel size used for the glow.
Static Default
The default texture size ratio used for the glow.
Static Readonly Effect
Effect Name of the layer.
Accessors
blur
Gets the kernel size of the blur.
Returns number
Sets the kernel size of the blur.
Parameters
value: number
Returns void
camera
intensity
Gets the glow intensity.
Returns number
Sets the glow intensity.
Parameters
value: number
Returns void
main
Gets the main texture where the effect is rendered
Returns RenderTargetTexture
rendering
Gets the rendering group id the layer should render in.
Returns number
Gets the rendering group id the layer should render in.
Parameters
renderingGroupId: number
Returns void
Methods
add
Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
Parameters
mesh: Mesh
The mesh to exclude from the glow layer
Returns void
add
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
disposeSearch playground for dispose
Dispose the highlight layer and free resources.
Returns void
get
Gets the class name of the effect layer
Returns string
the string with the class name of the effect layer
get
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
get
Get the effect name of the layer.
Returns string
The effect name
has
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
is
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
need
Returns whether or not the layer needs stencil enabled during the mesh rendering.
Returns boolean
reference
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
remove
Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
Parameters
mesh: Mesh
The mesh to remove
Returns void
remove
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
renderSearch playground for render
Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
Returns void
serializeSearch playground for serialize
Serializes this glow layer
Returns any
a serialized glow layer object
set
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
set
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
Optional material: 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
should
Returns true if the layer contains information to display, otherwise false.
Returns boolean
true if the glow layer should be rendered
un
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
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