Class LensFlareSystem
Hierarchy
- LensFlareSystem
Index
Constructors
constructor
Instantiates a lens flare system. This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses. It is usually composed of several
lensFlare.Parameters
name: string
Define the name of the lens flare system in the scene
emitter: any
Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
scene: Scene
Define the scene the lens flare system belongs to
Returns LensFlareSystem
Properties
border
Define a limit from the border the lens flare can be visible.
idSearch playground for id
Define the id of the lens flare system in the scene. (equal to name by default)
layer
Restricts the rendering of the effect to only the camera rendering this layer mask.
lens
List of lens flares used in this system.
meshes
Type declaration
Define a predicate which could limit the list of meshes able to occlude the effect.
Parameters
mesh: AbstractMesh
Returns boolean
nameSearch playground for name
Define the name of the lens flare system
viewport
Define a viewport border we do not want to see the lens flare in.
Accessors
is
Define if the lens flare system is enabled.
Returns boolean
Define if the lens flare system is enabled.
Parameters
value: boolean
Returns void
scene
Gets the scene
Returns Scene
Methods
disposeSearch playground for dispose
Dispose and release the lens flare with its associated resources.
Returns void
get
Get the emitter of the lens flare system. It defines the source of the lens flares (it can be a camera, a light or a mesh).
Returns any
the emitter of the lens flare system
get
Get the lens flare system emitter position. The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
Returns Vector3
the position
get
Get the scene the effects belongs to.
Returns Scene
the scene holding the lens flare system
rebuildSearch playground for rebuild
Rebuilds the lens flare system
Returns void
serializeSearch playground for serialize
Serialize the current Lens Flare System into a JSON representation.
Returns any
the serialized JSON
set
Set the emitter of the lens flare system. It defines the source of the lens flares (it can be a camera, a light or a mesh).
Parameters
newEmitter: any
Define the new emitter of the system
Returns void
Static ParseSearch playground for Parse
Parse a lens flare system from a JSON representation
Parameters
parsedLensFlareSystem: any
Define the JSON to parse
scene: Scene
Define the scene the parsed system should be instantiated in
rootUrl: string
Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
Returns LensFlareSystem
the parsed system
This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses. It is usually composed of several
lensFlare.https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare