Class EffectLayer Abstract
Hierarchy
- EffectLayer
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Instantiates a new effect Layer and references it in the scene.
Parameters
name: string
The name of the layer
Optional scene: Scene
The scene to use the layer in
Returns EffectLayer
Properties
disable Bounding Boxes From Effect LayerSearch playground for disableBoundingBoxesFromEffectLayer
Specifies if the bounding boxes should be rendered normally or if they should undergo the effect of the layer
is EnabledSearch playground for isEnabled
Specifies whether the highlight layer is enabled or not.
nameSearch playground for name
The name of the layer
neutral ColorSearch playground for neutralColor
The clear color of the texture used to generate the glow map.
on After Compose ObservableSearch playground for onAfterComposeObservable
An event triggered when the generated texture has been merged in the scene.
on After Render Mesh To EffectSearch playground for onAfterRenderMeshToEffect
An event triggered after the mesh has been rendered into the effect render target.
on Before Compose ObservableSearch playground for onBeforeComposeObservable
An event triggered when the generated texture is being merged in the scene.
on Before Render Main Texture ObservableSearch playground for onBeforeRenderMainTextureObservable
An event triggered when the effect layer is about rendering the main texture with the glowy parts.
on Before Render Mesh To EffectSearch playground for onBeforeRenderMeshToEffect
An event triggered when the mesh is rendered into the effect render target.
on Dispose ObservableSearch playground for onDisposeObservable
An event triggered when the effect layer has been disposed.
on Size Changed ObservableSearch playground for onSizeChangedObservable
An event triggered when the effect layer changes its size.
Accessors
camera
main Texture
Gets the main texture where the effect is rendered
Returns RenderTargetTexture
rendering Group Id
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
Abstract _dispose MeshSearch playground for _disposeMesh
Free any resources and references associated to a mesh. Internal use
Parameters
mesh: Mesh
The mesh to free.
Returns void
disposeSearch playground for dispose
Dispose the highlight layer and free resources.
Returns void
get Class NameSearch playground for getClassName
Gets the class name of the effect layer
Returns string
the string with the class name of the effect layer
Abstract get Effect NameSearch playground for getEffectName
Get the effect name of the layer.
Returns string
The effect name
has MeshSearch playground for hasMesh
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
Abstract is ReadySearch playground for isReady
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
Abstract need StencilSearch playground for needStencil
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.
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
Optional Abstract serializeSearch playground for serialize
Serializes this layer (Glow or Highlight for example)
Returns any
a serialized layer object
set Material For RenderingSearch playground for setMaterialForRendering
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 RenderSearch playground for shouldRender
Returns true if the layer contains information to display, otherwise false.
Returns boolean
true if the glow layer should be rendered
Static ParseSearch playground for Parse
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
The effect layer Helps adding post process effect blended with the main pass.
This can be for instance use to generate glow or highlight effects on the scene.
The effect layer class can not be used directly and is intented to inherited from to be customized per effects.