Class LensFlare

constructor

• new LensFlare(
      size: number,
      position: number,
      color: Color3,
      imgUrl: string,
      system: LensFlareSystem,
  ): LensFlare

  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 lensFlareSystem this flare is part of

  Returns LensFlare

  See

  https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare

alphaMode

color

position

size

texture

dispose

• dispose(): void

  Dispose and release the lens flare with its associated resources.

  Returns void

StaticAddFlare

• AddFlare(
      size: number,
      position: number,
      color: Color3,
      imgUrl: string,
      system: LensFlareSystem,
  ): LensFlare

  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 lensFlareSystem this flare is part of

  Returns LensFlare

  The newly created Lens Flare

  See

  https://doc.babylonjs.com/features/featuresDeepDive/environment/lenseFlare