Class EffectLayer
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
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.
Accessors
camera
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 any
-
Methods
Abstract _dispose
-
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
-
Gets the class name of the effect layer
Returns string
the string with the class name of the effect layer
Abstract get
-
Get the effect name of the layer.
Returns string
The effect name
has
-
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
-
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
-
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
-
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
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.