Class LensFlare
Hierarchy
- LensFlare
Index
Constructors
constructor
Instantiates a new Lens Flare. This represents one of the lens effect in a
lensFlareSystem. It controls one of the individual texture used in the effect.Parameters
size: number
Define the size of the lens flare in the system (a floating value between 0 and 1)
position: number
Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
color: Color3
Define the lens color
imgUrl: string
Define the lens texture url
system: LensFlareSystem
Define the
lensFlareSystemthis flare is part of
Returns LensFlare
Properties
alpha
Define the alpha mode to render this particular lens.
colorSearch playground for color
Define the lens color.
positionSearch playground for position
Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
sizeSearch playground for size
Define the size of the lens flare in the system (a floating value between 0 and 1)
textureSearch playground for texture
Define the lens texture.
Methods
disposeSearch playground for dispose
Dispose and release the lens flare with its associated resources.
Returns void
Static Add
Creates a new Lens Flare. This represents one of the lens effect in a
lensFlareSystem. It controls one of the individual texture used in the effect.Parameters
size: number
Define the size of the lens flare (a floating value between 0 and 1)
position: number
Define the position of the lens flare in the system. (a floating value between -1 and 1). A value of 0 is located on the emitter. A value greater than 0 is beyond the emitter and a value lesser than 0 is behind.
color: Color3
Define the lens color
imgUrl: string
Define the lens texture url
system: LensFlareSystem
Define the
lensFlareSystemthis flare is part of
Returns LensFlare
The newly created Lens Flare
This represents one of the lens effect in a
lensFlareSystem. It controls one of the individual texture used in the effect.https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare